Callbacks
SEEN can configure a callback to your API once we have completed a video generation request.
You will need to supply us with the endpoint URL.
We support the following authorization methods:
- Basic
- Static token
- Oauth2
The shape of the JSON payloads we send to your API will be customised per client/campaign.
Here's an example:
{
"customer_id": "101",
"campaign_slug": "onboarding",
"landing_page_url": "your.subdomain.com/v/12345",
"video_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/output.m3u8",
"thumbnail_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/thumbnail.jpg",
"email_thumbnail_url": "https://motions.seen.io/298abdcf-1f0f-46e7-9c26-a35b4c1e83cc/d3c1dffdf063986ad521a63e3e68fd7d1100c90a/email_thumbnail.jpg"
}
Each request will contain a single JSON object, with each representing a receiver’s generated video. Fields are as follows:
- customer_id - The id you supplied when you first created the receiver with our API. (string)
- campaign_slug - The campaign ID for your film, more information here. (string)
- landing_page_url - The URL to the receivers unique landing page. (string)
- video_url - The URL to the generated video. The URL will point to a HLS index playlist file. (string)
- thumbnail_url - The URL to the generated video's thumbnail image. (string)
- email_thumbnail_url - The URL to the generated video's thumbnail image with an added play-button overlay. (string)
If we receive a non-success response, we will automatically retry 2 times with a 60 second timeout between the calls (3 calls in total).
Did this answer your question?
😞
😐
🤩
Last updated on April 30, 2024