Beacon Store Webhook Reference (1.0.3)

Download OpenAPI specification:Download

Reference for the Brightcove Beacon Webhook. Base URL: https://beacon.brightcove.com/{project}

Changelog

v 1.0.3 (2021-03-01)

Endpoint POST '/webhook/beacon' added body property 'asset_sku'. v 1.0.2 (2021-01-05)
Endpoint POST '/webhook/beacon' body property 'efective_cancelation_date' updated to 'effective_cancellation_date'.
Endpoint POST '/webhook/beacon' body property 'notification_type' "cancelation" updated to "cancellation".

WebHook

Operations for creating/updating App user subscriptions from multiple stores. External asset ingestion. Beacon live event updates.

Update user beacon store

Beacon subscriptions(SVOD) or buy/rent update

header Parameters

auth-token

required

string

{Webhook_Api_Key}

Request Body schema: application/json

body subscriptions

Array

package_name required	string (SVOD/TVOD) Package name (original name in plans), or for TVOD (buy/rent) asset video id ( used when plan beaconstoremigration is available, to be deprecated, should use asset_sku in combination with the TVOD package_name)
payment_gateway required	string <= 50 characters Payment gateway (should be beaconstore)
external_user_id	string user app beacon_external_id
transaction_id required	string <= 191 characters transaction id, unique value used for subscriptions mainly in order to update or create subscriptions
start_date required	integer [ 10 .. 13 ] characters Start date Unix timestamp
end_date	integer or null [ 10 .. 13 ] characters End date Unix timestamp (SVOD (new, renew, cancellation) and rent)
trial_end_date	integer or null [ 10 .. 13 ] characters Trial end date Unix timestamp ( only used when notification_type = new/renew and SVOD)
effective_cancellation_date	integer or null [ 10 .. 13 ] characters Cancellation date Unix timestamp ( only when notification_type = cancellation)
notification_type required	string Enum: "new" "renew" "cancellation" "buy" "rent" new,renew,cancellation,buy,rent
notification_date required	integer [ 10 .. 13 ] characters Notification date Unix timestamp
asset_sku	string Optional value for asset, should be used for buy/rent not grouped (video id)

Responses

Request samples

Payload

Content type

application/json

[{"package_name": "string",
"payment_gateway": "string",
"external_user_id": "string",
"transaction_id": "string",
"start_date": 1615998269,
"end_date": 1615998269,
"trial_end_date": 1615998269,
"effective_cancellation_date": 1615998269,
"notification_type": "new",
"notification_date": 1615998269,
"asset_sku": "string"
}
]

Response samples