Sign in

v50

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-2810050281.4 KB
Notifications

Create Subscription

Establishes up to 10 endpoints that video changes should be sent to. Any change in video metadata will trigger a video change event and a notification - changes to assets used by the video will not trigger change events.

post/v1/accounts/{{account_id}}/subscriptions

Path parameters

account_idstring required

Video Cloud account ID.

Headers

Content-Typestring required

Content-Type: application/json

Authorizationstring required

Authorization: Bearer {access_token} - see Getting Access Tokens

Request body

endpointstring

the notifications endpoint

eventsstring[]

list of events subscribed to

idstring

system id for the subscription

service_accountstring

the Video Cloud account id

Example request

{
  "endpoint": "https://solutions.brightcove.com/bcls/di-api/cms-callbacks.php",
  "events": [
    "video-change"
  ],
  "id": "a0847083-79f4-4315-8a2c-403465a3d9bc",
  "service_account": "57838016001"
}

Response

Subscription created

endpointstring

the notifications endpoint

eventsstring[]

list of events subscribed to

idstring

system id for the subscription

service_accountstring

the Video Cloud account id

Example response

{
  "endpoint": "https://solutions.brightcove.com/bcls/di-api/cms-callbacks.php",
  "events": [
    "video-change"
  ],
  "id": "a0847083-79f4-4315-8a2c-403465a3d9bc",
  "service_account": "57838016001"
}