BEbeyondwords
Webhooks

Create webhook

Creates a webhook for a project to receive HTTP notifications when content changes.

Deliveries use the audio.updated action type. See #/components/examples/audioUpdatedWebhookDeliveryExample for a representative payload (media IDs are integers, content_type values are mp3/m3u8/mp4, and duration is in seconds).

Content without audio generation (generate_audio is false) sends content.ready with the ready state and without media once it is prepared and indexed (see #/components/examples/contentReadyWebhookDeliveryExample), or audio.error if the preparation fails.

post/projects/{project_id}/webhooks

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/webhooks
  • Auth
    API key in header X-Api-Key

Request body

urlstring required

The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS

headersobject
use_static_ipboolean

Whether requests to URL should originate from a static IP address.

enabledboolean

Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true.

Response

successful

idinteger

Unique identifier for the object

urlstring

The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS

headersobject
enabledboolean

Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true.

use_static_ipboolean

Whether requests to URL should originate from a static IP address.

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

Changes

No recorded changes to this operation across all 2 revisions of this API.