OCT-103 Gumlet outreach
POST/org/webhooks

Create a webhook listener

Creates a webhook listener that sends JSON to your configured url when subscribed events occur. Provide url, secret_token, triggers, and sources; Gumlet sends the secret in the x-gumlet-token header so you can verify webhook requests. Refer to the webhooks documentation for payload schemas.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Webhook listener configuration. Provide url, secret_token, triggers, and sources.

secret_tokenstringrequired

Secret sent back in the x-gumlet-token header of each webhook POST so you can confirm the request came from Gumlet.

sourcesarray<string>required

List of video collection identifiers for which webhooks are needed to be invoked.

triggersarray<string>required

Events that invoke this webhook. status subscribes to every video asset status event. live-video-status subscribes to every live video status event. Any other value subscribes to that event only.

urlstringrequired

URL from the application you want to send data to.

5 status codes
200Returns the created webhook object, including its ID, URL, secret token, configured sources and triggers, and creation and update timestamps.
created_atstringoptional
idstringoptional

Webhook ID

secret_tokenstringoptional
sourcesarray<string>optional
triggersarray<string>optional

List of triggers

updated_atstringoptional
urlstringoptional

Webhook URL

400Returned when the request is malformed.

One documented failure

  • invalid_parameter_value

    The parameter value you have provided is not valid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

A 400 is returned for a bad request, a 401 when the API key or bearer token is missing or invalid, a 403 when the account is unpaid or lacks the required role permissions, and a 422 when request validation fails. url, secret_token, triggers, and sources are required. triggers must contain supported event names; sources must contain video collection identifiers.