campaignId, contactInfo, videoLink, and workspaceId, plus additional event-specific properties for CTA clicks, watch percentage, and video-ready-to-download events.
Key takeaways
- Every webhook payload includes core properties such as
campaignId,campaignName,contactInfo,creatorId,dynamicCampaignId,videoLink,embedLink,thumbnailUrl, andworkspaceId. campaignIdrefers to the individual generated video, which is different from the Dynamic Video Campaign ID (dynamicCampaignId) that covers all videos created from the campaign.- Some events add extra properties: Video CTA Clicked adds
ctaTextandctaLink; Video Watched % addswatchPercentage. - The Video Ready to Download (
video_mp4_ready) webhook adds download links in low, medium, and high quality, plus anemailDownloadLinkand adownloadVideoLinksarray.
Sendspark Webhook Properties:
Additional properties per event:
Video CTA Clicked:
Video Watched %:
Webhook: Video Ready to Download: video_mp4_ready
Properties for ALL webhooks:
Properties in contactInfo:
Property at root level:
Properties for “Video Ready to Download” webhook (video_mp4_ready):
Additional property:
Frequently asked questions
What's the difference between campaignId and dynamicCampaignId?
What's the difference between campaignId and dynamicCampaignId?
campaignId identifies the individual dynamic video that was created for a single contact. dynamicCampaignId identifies the parent dynamic campaign that all of those videos were created from.What information is included in contactInfo?
What information is included in contactInfo?
The
contactInfo object holds details about the prospect the video was created for, including contactEmail and contactFirstName, plus jobTitle, company, backgroundUrl, and a fields object with any custom fields.Which extra properties come with the Video Ready to Download webhook?
Which extra properties come with the Video Ready to Download webhook?
The
video_mp4_ready webhook adds emailDownloadLink, download links for low, medium, and high quality (downloadVideoLinkLow, downloadVideoLinkMedium, downloadVideoLinkHigh), and a downloadVideoLinks array with all available links.How do I know which event triggered a webhook?
How do I know which event triggered a webhook?
Check the
eventType property, which names the event that fired the webhook (for example, video_mp4_ready or video_generated_dv).Where do I set up webhooks in the first place?
Where do I set up webhooks in the first place?
Before using these properties, review the guide on how to create webhooks in Sendspark.