Interface WebhookCreateParams

interface WebhookCreateParams {
    api_version?: string;
    name?: string;
    state?: "disabled" | "enabled" | "disabled_due_to_failed_deliveries";
    subscribed_events: (
        | string & {}
        | "batch.succeeded"
        | "batch.cancelled"
        | "batch.expired"
        | "batch.failed"
        | "interaction.requires_action"
        | "interaction.completed"
        | "interaction.failed"
        | "interaction.cancelled"
        | "video.generated"
    )[];
    uri: string;
    webhook_id?: string;
}

Properties

api_version? name? state? subscribed_events uri webhook_id?

Properties

Optionalapi_version

api_version?: string

Path param: Which version of the API to use.

Optionalname

name?: string

Body param: Identifier. The name of the webhook. Format: webhooks/{webhook_id}

Optionalstate

state?: "disabled" | "enabled" | "disabled_due_to_failed_deliveries"

Body param: The state of the webhook.

subscribed_events

subscribed_events: (
    | string & {}
    | "batch.succeeded"
    | "batch.cancelled"
    | "batch.expired"
    | "batch.failed"
    | "interaction.requires_action"
    | "interaction.completed"
    | "interaction.failed"
    | "interaction.cancelled"
    | "video.generated"
)[]

Body param: Required. The events that the webhook is subscribed to. Available events:

  • batch.succeeded
  • batch.cancelled
  • batch.expired
  • batch.failed
  • interaction.requires_action
  • interaction.completed
  • interaction.failed
  • interaction.cancelled
  • video.generated

uri

uri: string

Body param: Required. The URI to which webhook events will be sent.

Optionalwebhook_id

webhook_id?: string

Query param: Optional. The webhook_id to use for the webhook. If not specified, the server will generate a unique ID.

Settings

On This Page

Properties