Introduction
When creating scheduler workflows, you can optionally configure a notification_url. After each task completes (or before it runs, for pre-notifications), the scheduler sends an HTTP POST to your endpoint with the action performed and success or failure details.
Configuring notifications
- Start/stop scheduler
-
- Set
notification_urlat the top level of the request body - Set
notification(seconds before the event) onstart_actionand/orstop_action
{ "job_id": "6386637563112", "notification_url": "https://example.com/live/jobstartstop/callbacks", "start_action": { "time_utc": 1612274100, "notification": 600 }, "stop_action": { "time_utc": 1612281600, "notification": 600 } } - Set
- Clips scheduler
-
- Set
notification_urlat the top level of the request body - Set
notificationon theclipobject (seconds beforetime_utc)
{ "job_id": "6386637563112", "notification_url": "https://example.com/live/clip/callbacks", "clip": { "time_utc": 1612879800, "notification": 600, "clip_request": { "name": "Scheduled clip", "start": "2021-02-09T13:55:00Z", "end": "2021-02-09T14:10:00Z" } } } - Set
Notification body
Notifications are JSON POST requests. Fields include:
| Field | Description |
|---|---|
action |
Action name (see table below) |
workflow |
Updated workflow after action completion |
error |
Present if the action failed |
Actions
| Action | Workflow type | Description |
|---|---|---|
notify-start |
jobstartstop |
Pre-notification before the channel starts |
start |
jobstartstop |
Start action completed. If error is present, start failed and stop is cancelled |
notify-stop |
jobstartstop |
Pre-notification before the channel stops |
stop |
jobstartstop |
Stop action completed |
notify-clip |
clip |
Pre-notification before clip generation runs |
clip |
clip |
Clip action completed |