How to Configure Webhook Notifications in Boomstream
Boomstream provides URL notifications (webhooks) to automatically notify your external systems, CRM, or CMS about various events occurring on the platform in real time.
How Webhook Notifications Work
When a specified event occurs, Boomstream automatically sends an HTTP POST request to the URL configured in your project settings. This request payload includes the video file code as a POST parameter (`code`).
Response Handling and Retry Logic
Boomstream monitors the HTTP response from your server to ensure successful delivery:
| Server Response | System Action |
|---|---|
| HTTP 200 OK | Positive response — the notification is considered successfully delivered. |
| Other HTTP code | The notification has failed and will be repeated after 10 minutes. |
| Third attempt | Performed 15 minutes after the first attempt. If it fails again, the retry sequence stops. |
Supported Webhook Events
The following events trigger webhook notifications:
| Event Name | Description |
|---|---|
`media.created` |
A new video file has been successfully created. |
`media.completed` |
Video file processing (transcoding) is successfully completed. |
`media.failed` |
An error occurred during video file processing. |
`ppv.bought` |
A user has successfully purchased access to the video. |
`live.started` |
A live stream has begun broadcasting. |
`live.stopped` |
A live stream has ended or been stopped. |
`screenshots.completed` |
Thumbnail covers for the media have been successfully generated. |
`password.activate` |
A user has successfully activated an access password. |
`transcode.completed` |
A specific video transcode (resolution) creation is completed. |
? Detailed Documentation: For comprehensive payload examples and advanced details, please refer to the Webhooks Developer Documentation.
How to Configure Webhooks
You can set up webhook endpoints using either of the following methods:
| Configuration Method | Instructions |
|---|---|
| Via Dashboard | Navigate to Project settings → Webhooks section and add your target URL. |
| Via API | Use the dedicated Webhooks API endpoints to manage notifications programmatically. |
Requesting Custom Webhook Notifications
If your integration requires additional event notifications that are not included in the standard list above, please contact our technical support team at support@boomstream.com to discuss custom webhook implementations.