OCT-103 Gumlet outreach
POST/org/webhooks/{webhook_id}

Update a webhook listener

Updates the configuration of an existing webhook listener. Use webhook_id to select the listener and provide the settings you want to change, such as its destination URL, subscribed events, sources, or secret token. The response contains the webhook configuration after the update.

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

1 parameter · 4 body fields
webhook_idstringrequired

The unique identifier of the webhook listener you want to update.

Webhook listener settings to update. The schema does not require any particular body fields.

secret_tokenstringoptional

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

sourcesarray<string>optional

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

triggersarray<string>optional

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.

urlstringoptional

URL from the application you want to send data to.

4 status codes
200Returns the updated 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
updated_atstringoptional
urlstringoptional

Webhook URL

400Returned when the request is malformed.

One documented failure

  • webhook_not_found

    Could not find any webhook with the specified webhook_id.

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

Error handling

A 400 is returned for a bad request, a 401 when the API key or bearer token is missing or invalid, and a 403 when the account is unpaid or lacks the required role permissions. The webhook_id path parameter identifies the listener to update. If you include triggers, use supported event names; status and live-video-status subscribe to the corresponding event groups.