Webhooks in Sendspark allow you to subscribe to specific events from a video events for your dynamic video campaigns. By integrating webhooks, you can automate actions based on user interactions or system events within your Sendspark account.
Before you get started, please review this article on how to use Sendspark webhooks.
Sendspark Webhook Properties:
Name | Type | Description |
| string | ID for the campaign created. |
| string | Name for the campaign created. |
| object | Object with information about the prospect. |
| string | The email address of the prospect used to create the campaign. |
| string | The name of the prospect used to create the campaign. |
| string | The ID of the individual who created the campaign. |
| string | The name of the individual who created the campaign. |
| string | The ID of the dynamic campaign under which the campaign was created. |
| string | The name of the dynamic campaign under which the campaign was created. |
| string | The link that redirects to the video that was created. |
| string | The link that redirects to the video embed that was created. |
| string | The link that redirects video thumbnail that was created. |
| string | The ID of the workspace containing the dynamic campaign where the video was created. |
| string | The name of the workspace containing the dynamic campaign where the video was created. |
Additional properties per event:
Video CTA Clicked:
Name | Type | Description |
| string | The text displayed on the clicked CTA. |
| string | The link to which the clicked CTA redirects. |
Video Watched %:
Name | Type | Description |
| number | The percentage of the video the visitor watched before pausing, stopping, or finishing it. |
Webhook: Video Ready to Download: video_mp4_ready
Properties for ALL webhooks:
Properties in contactInfo:
Name | Type | Description |
jobTitle | string | The job title of the prospect. |
company | string | The company name of the prospect. |
backgroundUrl | string | The background image URL of the prospect. |
fields | object | Object with custom fields of the prospect. |
Property at root level:
Name | Type | Description |
emailEmbedHTML | string | HTML code to embed the video in emails. |
Properties for "Video Ready to Download" webhook (video_mp4_ready):
Name | Type | Description |
emailDownloadLink | string | HTML link to download the video in emails. |
downloadVideoLinkLow | string | Download link for low quality video. |
downloadVideoLinkMedium | string | Download link for medium quality video. |
downloadVideoLinkHigh | string | Download link for high quality video. |
downloadVideoLinks | array | Array with all available download links. |
Additional property:
Name | Type | Description |
eventType | string | The event type that triggered the webhook (e.g., video_mp4_ready, video_generated_dv, etc.). |