Webhooks
We notify 3rd party applications via webhooks that can be configured in the CMS account settings.
Webhooks are global per account
The webhooks are configured per account, meaning that a specific webhook will fire regardless to the workspace the input is in.
Webhook call structure
The webhook will send a POST call to the endpoint with the following structure in the body:
{
action : ACTION_TYPE,
entity : ENTITY_TYPE,
data : ENTITY_PAYLOAD
}
Property | Type | Description |
---|---|---|
action | string | Describes the action that was taken to trigger this event. Action types are: create update delete |
entity | string | The type of the entity that was created, updated or deleted. Currently only inputs are supported |
data | JSON | This data of the entity that was created, modified or deleted. Refer to the specs of the different entities for details |
Inputs webhooks events
Input created
POST call will fire to the endpoint when a new input is created directly in the CMS or via the API.
The call will be sent with the following data in the body
{
action : "create",
entity : "input",
data : {
id : "HyP7O2v4D",
type : "vod",
name : "Soccer",
description:"Highlights from that last soccer match",
sources : [
name : "Soccer",
url. : "https://stream.videoflow.io/5eafd6490411f500139f4bc2/5c9dccaf67a496001499b730/hpvNUSjWv/1599747932879/1599747932879.m3u8"
],
captions : "https://gist.githubusercontent.com/samdutton/ca37f3adaf4e23679957b8083e061177/raw/e19399fbccbc069a2af4266e5120ae6bad62699a/sample.vtt",
thumbnail : "https://stream.videoflow.io/5eafd6490411f500139f4bc2/5c9dccaf67a496001499b730/hpvNUSjWv/1599747932879/thumbnails/1599747932879.0000003.jpg",
user : "5928aba013a23e2d84e17a19",
organization_owner : "5928aba013a23e2d84e17a19",
created_time : "2020-09-10T14:28:46.550Z",
updated_time : "2020-12-15T23:28:19.959Z",
start_date : "2020-09-21T04:00:00.000Z",
end_date : "2020-09-29T04:00:00.000Z",
end_time : "1970-01-01T12:31:00.000Z",
start_time : "1970-01-01T23:26:00.000Z",
workspaces : [
"5eb02fa186941a5ccc0831f7"
],
groups : [],
tags : [
"channel2"
],
metadata : {}
}
}
Updated almost 4 years ago