# Sendspark

Sendspark is a video messaging platform that empowers businesses to create, send, and track personalized video content, simplifying communication by allowing users to quickly record or upload videos and share them via email, social media, or other digital channels.

- **Category:** video & audio
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `SENDSPARK`
- **Version:** 20260312_00

## Tools

### Add Multiple Prospects to Dynamic Campaign

**Slug:** `SENDSPARK_ADD_MULTIPLE_PROSPECTS_TO_DYNAMIC_CAMPAIGN`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dynamicsId` | string | Yes | Dynamic campaign identifier |
| `workspaceId` | string | Yes | Workspace identifier |
| `prospectList` | array | Yes | List of prospects to add |
| `prospectDepurationConfig` | object | No | Configuration for prospect deduplication |
| `processAndAuthorizeCharge` | boolean | Yes | Must be true to confirm usage-based charges |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Prospect to Dynamic Video Campaign

**Slug:** `SENDSPARK_ADD_PROSPECT_TO_DYNAMIC_VIDEO_CAMPAIGN`

Tool to add a prospect to a dynamic video campaign. Use after confirming workspace and campaign IDs. Example: Add new prospect with name/contact details to dynamic "dyn12345" under a known workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prospect` | object | Yes | The prospect data to add to the dynamic video campaign. |
| `dynamicId` | string | Yes | Identifier of the dynamic video campaign. |
| `workspaceId` | string | Yes | Workspace identifier under which the campaign resides. |
| `prospectDepurationConfig` | object | No | Optional deduplication settings for prospect creation. |
| `processAndAuthorizeCharge` | boolean | Yes | Must be true to acknowledge and authorize any associated charges. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### API Health Status

**Slug:** `SENDSPARK_API_HEALTH_STATUS`

Tool to check the health status of the Sendspark API. Use before making other API calls to ensure the service is up.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dynamic Video Campaign V2

**Slug:** `SENDSPARK_CREATE_DYNAMIC_VIDEO_CAMPAIGN2`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the dynamic campaign. Must be unique within the workspace |
| `workspaceId` | string | Yes | The ID of the Sendspark workspace where the campaign will be created |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `SENDSPARK_DELETE_WEBHOOK`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Unique identifier of the webhook to delete. |
| `workspaceId` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dynamic Campaign by ID

**Slug:** `SENDSPARK_GET_DYNAMIC_CAMPAIGN_BY_ID`

Tool to retrieve details of a specific dynamic video campaign. Use after confirming workspace and campaign IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dynamic_id` | string | Yes | ID of the dynamic campaign to retrieve |
| `workspace_id` | string | Yes | ID of the workspace containing the dynamic campaign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace Prospect Data by Email

**Slug:** `SENDSPARK_GET_WORKSPACE_PROSPECT_DATA_BY_EMAIL`

Tool to retrieve prospect data by email in a dynamic campaign. Use after adding a prospect to a campaign to fetch its details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Prospect email address to retrieve data for |
| `dynamic_id` | string | Yes | Dynamic campaign identifier |
| `workspace_id` | string | Yes | Sendspark workspace identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dynamic Video Campaigns

**Slug:** `SENDSPARK_LIST_DYNAMIC_VIDEO_CAMPAIGNS`

Tool to list all dynamic video campaigns in a workspace. Use when retrieving campaigns with optional pagination, filtering, or search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of campaigns per page (max 20) |
| `offset` | integer | No | Pagination start index (1-based) |
| `search` | string | No | Search by campaign name |
| `filters` | string | No | Filter by creator ID |
| `workspaceId` | string | Yes | Workspace identifier where to list dynamic video campaigns |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `SENDSPARK_LIST_WEBHOOKS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspaceId` | string | Yes | Unique identifier for the Sendspark workspace. This alphanumeric ID can be obtained from the workspace settings or by listing dynamic video campaigns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |