Skip to main content
Sendspark logo
  • Category: video & audio
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: SENDSPARK
  • Version: 20261101_00

Tools

Slug: SENDSPARK_ADD_MULTIPLE_PROSPECTS_TO_DYNAMIC_CAMPAIGNTool to add multiple prospects to a dynamic campaign in bulk. Use when you need to add many prospects to your dynamic video campaign at once after confirming associated charges.

Input Parameters

string
required
Dynamic campaign identifier
string
required
Workspace identifier
array
required
List of prospects to add
object
Configuration for prospect deduplication
boolean
required
Must be true to confirm usage-based charges

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_ADD_PROSPECT_TO_DYNAMIC_VIDEO_CAMPAIGNAdd a prospect to a dynamic video campaign in a workspace. The request authorizes charges for video generation above the plan limit.

Input Parameters

object
required
The prospect data to add to the dynamic video campaign.
string
required
Identifier of the dynamic video campaign.
string
required
Workspace identifier under which the campaign resides.
object
Optional deduplication settings for prospect creation.
boolean
required
Must be true to acknowledge and authorize any associated charges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_API_HEALTH_STATUSTool to check the health status of the Sendspark API. Use before making other API calls to ensure the service is up.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_CREATE_DYNAMIC_VIDEO_CAMPAIGN2Tool to create a dynamic video campaign in a workspace. Use when you need to create a container for AI-personalized dynamic videos that can be sent to prospects.

Input Parameters

string
required
Name of the dynamic campaign. Must be unique within the workspace
string
required
The ID of the Sendspark workspace where the campaign will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_DELETE_WEBHOOKDelete a webhook by its unique ID. Returns a structured response with status code and message. This action is idempotent: deleting a non-existent webhook (404) with workspaceId provided returns success. Invalid webhook IDs return 400 with error details. Best practice: Always provide workspaceId to use the reliable workspace-scoped endpoint.

Input Parameters

string
required
Unique identifier of the webhook to delete.
string
Workspace unique identifier. Required to use the workspace-scoped endpoint (/v1/workspaces/{workspaceId}/webhooks/{webhook_id}). Strongly recommended: The unscoped endpoint (/api/webhooks/{webhook_id}) may not be available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_GET_DYNAMIC_CAMPAIGN_BY_IDTool to retrieve details of a specific dynamic video campaign. Use after confirming workspace and campaign IDs.

Input Parameters

string
required
ID of the dynamic campaign to retrieve
string
required
ID of the workspace containing the dynamic campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_GET_WORKSPACE_PROSPECT_DATA_BY_EMAILTool to retrieve prospect data by email in a dynamic campaign. Use after adding a prospect to a campaign to fetch its details.

Input Parameters

string
required
Prospect email address to retrieve data for
string
required
Dynamic campaign identifier
string
required
Sendspark workspace identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_LIST_DYNAMIC_VIDEO_CAMPAIGNSList a page of dynamic video campaigns in a workspace, with optional pagination, filtering, or search.

Input Parameters

integer
Number of campaigns per page (max 20)
integer
Pagination start index (1-based)
Search by campaign name
string
Filter by creator ID
string
required
Workspace identifier where to list dynamic video campaigns

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SENDSPARK_LIST_WEBHOOKSRetrieves all configured webhooks for a Sendspark workspace. Webhooks are automated notifications sent when specific events occur in dynamic video campaigns (e.g., video created, video played, CTA clicked, video opened). Use this action to audit active webhook configurations, verify webhook URLs, or check which events are being monitored. Returns an empty list if no webhooks are configured.

Input Parameters

string
required
Unique identifier for the Sendspark workspace. This alphanumeric ID can be obtained from the workspace settings or by listing dynamic video campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not