@apteva/integrations 0.2.3 → 0.3.1

package/src/apps/beehiiv.json

@@ -0,0 +1,252 @@
+{
+  "slug": "beehiiv",
+  "name": "beehiiv",
+  "description": "beehiiv newsletter platform integration. Manage publications, subscribers, and posts. Create and send newsletters, manage subscriber lists, and publish content.",
+  "logo": "https://www.google.com/s2/favicons?domain=beehiiv.com&sz=128",
+  "categories": [
+    "newsletter",
+    "email",
+    "publishing",
+    "subscribers",
+    "content"
+  ],
+  "base_url": "https://api.beehiiv.com/v2",
+  "auth": {
+    "types": [
+      "bearer"
+    ],
+    "headers": {
+      "Authorization": "Bearer {{token}}"
+    },
+    "credential_fields": [
+      {
+        "name": "token",
+        "label": "Api Key",
+        "description": "beehiiv API key (generate at app.beehiiv.com/settings/integrations)"
+      }
+    ]
+  },
+  "tools": [
+    {
+      "name": "list_publications",
+      "description": "Retrieve all publications associated with your beehiiv API key. Returns publication details including IDs, names, and settings.",
+      "method": "GET",
+      "path": "/publications",
+      "input_schema": {
+        "type": "object",
+        "properties": {}
+      }
+    },
+    {
+      "name": "list_subscribers",
+      "description": "List all subscribers for a specific publication. Supports pagination and filtering by email, status, and tier.",
+      "method": "GET",
+      "path": "/publications/%7B%7Bparam.publication_id%7D%7D/subscriptions",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "publication_id": {
+            "type": "string",
+            "description": "The ID of the publication (format: pub_xxxxx)."
+          },
+          "email": {
+            "type": "string",
+            "description": "Filter subscribers by email address. Optional."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "inactive",
+              "validating"
+            ],
+            "description": "Filter subscribers by status. Optional."
+          },
+          "limit": {
+            "type": "number",
+            "description": "Number of results to return per page. Max 100. Optional."
+          },
+          "cursor": {
+            "type": "string",
+            "description": "Pagination cursor from a previous response. Optional."
+          }
+        },
+        "required": [
+          "publication_id"
+        ]
+      }
+    },
+    {
+      "name": "create_subscriber",
+      "description": "Create a new subscriber (subscription) for a publication. Provide the subscriber's email and optional details like UTM parameters and custom fields.",
+      "method": "POST",
+      "path": "/publications/%7B%7Bparam.publication_id%7D%7D/subscriptions",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "publication_id": {
+            "type": "string",
+            "description": "The ID of the publication (format: pub_xxxxx)."
+          },
+          "email": {
+            "type": "string",
+            "description": "The email address of the new subscriber."
+          },
+          "reactivate_existing": {
+            "type": "boolean",
+            "description": "If true, reactivate an existing inactive subscription instead of failing. Defaults to false."
+          },
+          "send_welcome_email": {
+            "type": "boolean",
+            "description": "Whether to send the welcome email to the new subscriber. Defaults to false."
+          },
+          "utm_source": {
+            "type": "string",
+            "description": "UTM source for tracking where this subscriber came from."
+          },
+          "utm_medium": {
+            "type": "string",
+            "description": "UTM medium for tracking."
+          },
+          "utm_campaign": {
+            "type": "string",
+            "description": "UTM campaign for tracking."
+          },
+          "referring_site": {
+            "type": "string",
+            "description": "The URL of the site that referred this subscriber."
+          },
+          "custom_fields": {
+            "type": "array",
+            "description": "Array of custom field objects with 'name' and 'value' keys.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "Custom field name."
+                },
+                "value": {
+                  "type": "string",
+                  "description": "Custom field value."
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "publication_id",
+          "email"
+        ]
+      }
+    },
+    {
+      "name": "get_subscriber",
+      "description": "Retrieve a specific subscriber by their subscription ID. Returns detailed subscriber information including status, subscription date, and custom fields.",
+      "method": "GET",
+      "path": "/publications/%7B%7Bparam.publication_id%7D%7D/subscriptions/%7B%7Bparam.subscription_id%7D%7D",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "publication_id": {
+            "type": "string",
+            "description": "The ID of the publication (format: pub_xxxxx)."
+          },
+          "subscription_id": {
+            "type": "string",
+            "description": "The ID of the subscription/subscriber to retrieve."
+          }
+        },
+        "required": [
+          "publication_id",
+          "subscription_id"
+        ]
+      }
+    },
+    {
+      "name": "list_posts",
+      "description": "List all posts for a specific publication. Returns post details including title, status, publish date, and content metadata. Supports pagination.",
+      "method": "GET",
+      "path": "/publications/%7B%7Bparam.publication_id%7D%7D/posts",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "publication_id": {
+            "type": "string",
+            "description": "The ID of the publication (format: pub_xxxxx)."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "confirmed",
+              "archived"
+            ],
+            "description": "Filter posts by status. Optional."
+          },
+          "limit": {
+            "type": "number",
+            "description": "Number of results to return per page. Max 100. Optional."
+          },
+          "cursor": {
+            "type": "string",
+            "description": "Pagination cursor from a previous response. Optional."
+          }
+        },
+        "required": [
+          "publication_id"
+        ]
+      }
+    },
+    {
+      "name": "create_post",
+      "description": "Create a new post (newsletter) in a publication. Provide the title and content as raw HTML or structured blocks. Posts can be published immediately, scheduled, or saved as drafts.",
+      "method": "POST",
+      "path": "/publications/%7B%7Bparam.publication_id%7D%7D/posts",
+      "input_schema": {
+        "type": "object",
+        "properties": {
+          "publication_id": {
+            "type": "string",
+            "description": "The ID of the publication (format: pub_xxxxx)."
+          },
+          "title": {
+            "type": "string",
+            "description": "The title of the post."
+          },
+          "subtitle": {
+            "type": "string",
+            "description": "The subtitle/preview text for the post. Optional."
+          },
+          "body_content": {
+            "type": "string",
+            "description": "The content of the post as raw HTML. Either body_content or blocks must be provided."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "confirmed"
+            ],
+            "description": "Post status. 'confirmed' publishes immediately (or at scheduled_at time). 'draft' saves as draft. Defaults to 'confirmed'."
+          },
+          "scheduled_at": {
+            "type": "string",
+            "description": "ISO 8601 timestamp for when to publish the post. If not provided and status is 'confirmed', publishes immediately."
+          },
+          "authors": {
+            "type": "array",
+            "description": "Array of author IDs to attribute the post to.",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "publication_id",
+          "title"
+        ]
+      }
+    }
+  ]
+}