Skip to main content

​
integrationList

List all connected social media accounts (channels) for your organization. Parameters: Returns:

​
groupList

List all groups (customers) for your organization. Use a group’s id with integrationList to filter channels down to a single group. Parameters: None Returns:

​
integrationSchema

Get the posting rules, character limits, required settings, and available helper tools for a specific platform. Call this before scheduling a post to understand what the platform expects. Parameters: Returns: The tools array contains helper functions specific to the platform. For example, Discord returns a tool to list available channels, Reddit returns a tool to search for subreddits, and LinkedIn Page returns a tool to list pages. Each tool in the array has:

​
triggerTool

Execute a platform-specific helper function. These are discovered through integrationSchema and are used to fetch dynamic data like channel lists, subreddit suggestions, or page IDs. Parameters: Each item in dataSchema: Example use cases:
  • Get the list of Discord channels for a server
  • Search for Reddit subreddits
  • List LinkedIn pages you manage
  • Get Facebook page options
  • Search Instagram audio (audioSearch) to attach to a Reel — only on Facebook Business-linked Instagram channels

​
schedulePostTool

Schedule, draft, or immediately publish posts to social media platforms. This is the main tool for creating content. Parameters: Each item in socialPost: Each item in postsAndComments: Each item in settings:

​
Content Formatting

Content must be HTML with these allowed tags only:
You cannot combine <u> and <strong> in the same element. Each line of text must be wrapped in <p> tags.

​
Posts vs Comments

The postsAndComments array behavior depends on the platform:
  • Thread-based platforms (X, Threads, Bluesky): Each array item becomes a separate post in a thread
  • Comment-based platforms (LinkedIn, Facebook): First item is the post, remaining items are comments

​
Multiple Posts

To schedule multiple posts (e.g., 20 posts across different days), add multiple items to the socialPost array — each with its own date and integrationId. Returns: If validation fails, returns { errors: string } with details about what went wrong (e.g., content exceeds character limit).

​
generateImageTool

Generate an AI image to use as a post attachment. Parameters: Returns: Use the returned path in the attachments array when scheduling a post.

​
automationList

List all automation workflows for your organization, optionally filtered by integration. Parameters: Returns: Array of automation objects with id, name, integrationId, triggerType, active, successCount, failureCount.

​
automationCreate

Create a new automation workflow. Parameters: Returns: The created automation object including its assigned id.

​
automationUpdate

Update an existing automation workflow by ID. Parameters: Returns: The updated automation object.

​
automationToggleActive

Enable or disable an automation without changing its configuration. Parameters: Returns: The updated automation object.

​
automationDelete

Soft-delete an automation workflow. Execution logs are preserved. Parameters: Returns: Confirmation of deletion.
This is a destructive action. The automation will immediately stop firing on incoming events.

​
automationLogs

Retrieve paginated execution logs for an automation. Parameters: Returns:

​
automationTest

Dry-run the keyword matcher for an automation against a synthetic event. No actions are executed — no DM is sent, no comment is replied to, no log is written. Parameters: Returns: The match decision — whether the automation would have fired and which keyword matched.