Webhooks
The Streamdiver API facilites the efficient retrieval of events associated with API resources like e.g. Media
assets via webhooks.
Webhooks are automated callback messages sent from one application to another in response to specific events, e.g. when a Media
asset is updated or deleted.
Webhook events overview:
ping
- sent to validate the connection to configured URL after awebhook
create or update. This event can also be triggered manually using the ping actionmedia.created
- sent when a newMedia
is added to the system. This is typically triggered after an upload is completed, but also when eg. file is importedmedia.updated
- triggered when aMedia
is updated. The payload includes the updatedMedia
representation and an array of the properties that were modified.media.deleted
- sent onMedia
deletion. Includes information whether delete operation was permanentmedia.restored
- sent when a previously deletedMedia
is recovered.
๐๏ธ List webhooks
Returns a list of `Webhooks` the user has created.
๐๏ธ Create a webhook
Creates a new `Webhook` for the current user targeting the given `url`. Each user is limited to a specific number of active webhooks. If you reach this limit the create request will result in error. The limit per user can be found in `Tenant` system settings.
๐๏ธ Retrieve a webhook
Retrieves a `Webhook` by its identifier.
๐๏ธ Update a webhook
Updates a `Webhook` with the provided configuration.
๐๏ธ Delete a webhook
Deletes a `Webhook` by its identifier.
๐๏ธ Ping a webhook
Generates a `ping` event to test the `Webhook` configuration.
๐๏ธ List webhooks delivery logs
Lists `Webhook`s delivery logs.
๐๏ธ Retrieve a webhook delivery log
Retrieves a `Webhook` delivery log.
๐๏ธ Retry webhook delivery
Retries failed `Webhook` delivery.
๐๏ธ Webhook
HTTP POST request sent to the URL used in [webhook creation](#tag/Webhooks/operation/createWebhook).