API referenceConnect

GET /connect/{platform}

OAuth authorization URL for the account owner (valid 10 minutes, single use). Facebook: the owner picks Pages; the result may be a pending connection. WhatsApp: a Postgale page that runs Meta's Embedded Signup (several numbers → pending connection). Telegram has no OAuth: the answer is a one-time code (15 minutes) and instructions: a chat admin adds Postgale's bot as an admin with the right to post and sends /connect <code> in the channel or group (or forwards that channel post to the bot); the chat then appears in GET /accounts and account.connected is emitted. Discord: the owner picks the server and channel on Discord; Postgale stores the channel webhook (one account per webhook; platformAccountId = webhook id). Mastodon needs instance (the server's domain; public DNS names only): Postgale registers itself on that server if needed and the link opens its authorization page (platformAccountId = <id>@<server>). Bluesky has no OAuth: POST {handle, appPassword} (a Bluesky app password, never the account password) connects the account right away and answers {platform, account}; a refused handle or password is a 400. Platforms that are not live on this instance answer 400

GET
/connect/{platform}

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Path Parameters

platform*string
Value in"instagram""tiktok""x""linkedin""facebook""threads""whatsapp""telegram""discord""bluesky""mastodon"

Query Parameters

externalId?string

Your reference, stored on the connected account(s)

Lengthlength <= 200
instance?string

Mastodon server domain

Lengthlength <= 253

Response Body

{authUrl, expiresInSeconds}; for telegram {code, command, botUsername, instructions, expiresAt, expiresInSeconds}; for bluesky {platform, account}

application/json
  1. response
authUrl?string
expiresInSeconds?integer
Example Request
curl -X GET 'https://example.com/api/v1/connect/instagram'
Example Response
{  "authUrl": "string",  "expiresInSeconds": 0}

POST /accounts/{id}/webhook-subscription POST

Subscribe the account to Meta webhooks (Instagram: INSTAGRAM_WEBHOOK_FIELDS, default comments and the messaging fields; Facebook Page: FACEBOOK_WEBHOOK_FIELDS, default feed and the Messenger fields) so comment.received and message.* can be delivered. Messaging fields are left out when the account has not granted the messaging permission

POST /connect/{platform} POST

OAuth authorization URL for the account owner (valid 10 minutes, single use). Facebook: the owner picks Pages; the result may be a pending connection. WhatsApp: a Postgale page that runs Meta's Embedded Signup (several numbers → pending connection). Telegram has no OAuth: the answer is a one-time code (15 minutes) and instructions: a chat admin adds Postgale's bot as an admin with the right to post and sends /connect <code> in the channel or group (or forwards that channel post to the bot); the chat then appears in GET /accounts and account.connected is emitted. Discord: the owner picks the server and channel on Discord; Postgale stores the channel webhook (one account per webhook; platformAccountId = webhook id). Mastodon needs instance (the server's domain; public DNS names only): Postgale registers itself on that server if needed and the link opens its authorization page (platformAccountId = <id>@<server>). Bluesky has no OAuth: POST {handle, appPassword} (a Bluesky app password, never the account password) connects the account right away and answers {platform, account}; a refused handle or password is a 400. Platforms that are not live on this instance answer 400. Same as GET with externalId (and instance) in the JSON body; Bluesky needs POST with handle and appPassword