Webhooks API

Create webhook

Webhooks can push notifications to your server, rather than polling for changes. We currently offer four events:

encoding_started Occurs when the encoding process for a new video begins.

partial_finished Occurs when the encoding process for a quality of a video has been completed.

encoding_finished Occurs when the encoding process for a new video has been completed.

encoding_failed Occurs when the encoding process for a new video has failed.

file_received Occurs when a new video file has been successfully uploaded to the system.

The request body when create a webhook will look like this:

{
  "name": "your webhook name", // If not provided, the name will be the default (default_name_webhook).
  "url": "your link",
  "file_received": true, // The webhook event that you wish to filter on
  "encoding_started": true, // The webhook event that you wish to filter on
  "partial_finished": true, // The webhook event that you wish to filter on
  "encoding_finished": true, // The webhook event that you wish to filter on
  "encoding_failed": true // The webhook event that you wish to filter on
}

For example, this would be a simplified body for create webhook:

{
  "status": "success",
  "data": {
    "webhook": {
      "id": "string",
      "user_id": "string",
      "name": "string",
      "url": "string",
      "file_received": true,
      "encoding_started": true,
      "encoding_finished": true,
      "created_at": "2023-06-11T11:11:11.111111Z",
      "updated_at": "2023-06-11T11:11:11.111111Z",
      "last_triggered_at": "2023-06-11T11:11:11.111111Z"
    }
  }
}

POSThttps://api.aiozstream.network/api/webhooks

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

name Your webhook name. If not provided, the name will be the default (default-name-webhook).

url* The the url to which HTTP notifications are sent. It could be any http or https URL.

file_received he webhook event that you wish to filter on. Make sure you have 1 of 3.

encoding_started he webhook event that you wish to filter on. Make sure you have 1 of 3.

encoding_finished he webhook event that you wish to filter on. Make sure you have 1 of 3.

Response

201: Created

curl --location 'https://api.aiozstream.network/api/webhooks' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "file_received": false,
    "encoding_started": true,
    "encoding_finished": true,
    "url": "string",
    "name": "string"
}'

List webhook

Retrieve a list of all webhooks configured for the current workspace.

GEThttps://api.aiozstream.network/api/webhooks

Query

offset The number of records to skip before returning results (default: 0)

limit The maximum number of records to return in a query (default: 25, max: 100)

sort_by The field to sort results by (created_at, url, or name). Default: created_at

order_by The order of the results (asc or desc). Default: asc

encoding_finished Whether to filter results based on encoding completion (true)

encoding_started Whether to filter results based on encoding start (true)

file_received Whether to filter results based on file reception (true)

search Only support search by name

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location 'https://api.aiozstream.network/api/webhooks?search=string&limit=1&sort_by=created_at&order_by=asc&encoding_started=true' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json'

Retrieve webhook

Retrieve a webhook by its unique identifier.

GEThttps://api.aiozstream.network/api/webhooks/:id

Parameters

id* The unique identifier of the Webhook to be deleted.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location 'https://api.aiozstream.network/api/webhooks/{webhook_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json'

Update webhook

This endpoint is used to update the webhook.

PATCHhttps://api.aiozstream.network/api/webhooks/:id

Parameters

id* The unique identifier of the Webhook Id to be update.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Body

url The the url to which HTTP notifications are sent. It could be any http or https URL.

file_received The webhook event that you wish to change. True or False.

encoding_started The webhook event that you wish to change. True or False.

partial_finished The webhook event that you wish to change. True or False.

encoding_finished The webhook event that you wish to change. True or False.

encoding_failed The webhook event that you wish to change. True or False.

name Your webhook name.

Response

200: OK

curl --location --request PATCH 'https://api.aiozstream.network/api/webhooks/{webhook_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "file_received": true,
  "encoding_started": false,
  "encoding_finished": true,
  "name": "string",
  "url": "string"
}'

Delete webhook

This endpoint is used to update the webhook.

DELETEhttps://api.aiozstream.network/api/webhooks/:id

Parameters

id* The unique identifier of the Webhook Id to be update.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location --request DELETE 'https://api.aiozstream.network/api/webhooks/{webhook_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json'

Trigger webhook

This endpoint is used to trigger the webhook.

POSThttps://api.aiozstream.network/api/webhooks/check/:id

Parameters

id* The unique identifier of the webhook Id to be trigger.

Headers

Authorization Bearer your_access_token_here

stream-public-key your_public_key_here

stream-secret-key your_secret_key_here

Response

200: OK

curl --location --request POST 'https://api.aiozstream.network/api/webhooks/check/{webhook_id}' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--header 'accept: application/json'

PreviousUsers NextPlayers