Overview - Integrations APIs

Programmatic endpoints for connecting social channels, channel groups, global plugs, and provider-specific tools using a workspace programmatic token.

2 min read

Connect your agent today

Draft from chat, review in your calendar, and publish only what you approve.

Start for $0

Endpoints

List Integrations

Return every connected social channel for the token's workspace

List Channel Groups

Return workspace channel groups — filter List Integrations with ?group=

Connect Channel (OAuth)

Generate an OAuth authorization URL for a provider — the first step in connecting a new channel

Delete Channel

Soft-delete a connected channel and every post group that includes it

Check Connection

Lightweight healthcheck — confirm the supplied programmatic or OAuth app token is accepted

Channel settings & tools

Fetch rules, max post length, settings schema, and the allow-listed tools for a connected channel

Trigger a channel tool

Invoke an allow-listed provider method on a connected channel

Plug Catalog

Discover global plug types per provider (methodName and field names)

List Global Plugs

Return saved global plug rules for one connected channel

Upsert Global Plug

Create or update a likes-threshold engagement rule on a channel

Delete Global Plug

Remove a saved global plug rule by plug row id

Activate Global Plug

Enable or disable a global plug rule without deleting it

Note

OAuth callback exchange (the redirect that finalizes a connection) is handled internally by the web app and is intentionally not part of the public API surface — see Connect Channel (OAuth).

Typical flow

Connect — call GET /public/social/{integration}, redirect the user to the returned URL, and let the provider complete the OAuth handshake. The new channel then appears in GET /public/integrations.
Inspect — call GET /public/integration-settings/{id} to discover the channel's rules, maxLength, settings schema, and the list of allow-listed tools.
Invoke — for any tool advertised in step 2, call POST /public/integration-trigger/{id} with the methodName and (optionally) a data payload matching that tool's dataSchema.

Channel groups

When a workspace assigns channels to logical customers, call GET /public/groups and pass a group id as group on GET /public/integrations (and as customerGroupId on GET /public/posts/list).

Global plugs

Global plugs are channel-level rules (auto-reply or repost when likes cross a threshold). They are separate from internal plugs configured per post on POST /public/posts — see Public API → Plugs.

Catalog — GET /public/plug-catalog returns each provider's methodName values and field definitions.
List — GET /public/integration-plugs/{id} returns saved rules on a channel.
Upsert — POST /public/integration-plugs/{id} with func (catalog methodName) and fields name/value pairs.
Pause or remove — PUT /public/plugs/{plugId}/activate or DELETE /public/plugs/{plugId}.