Type Alias Webhook

Webhook: {
    create_time?: string;
    id?: string;
    name?: string;
    new_signing_secret?: string;
    signing_secrets?: SigningSecret[];
    state?: WebhookState;
    subscribed_events: WebhookSubscribedEvent[];
    update_time?: string;
    uri: string;
}

A Webhook resource.

Type declaration

  • Optionalcreate_time?: string

    Output only. The timestamp when the webhook was created.

  • Optionalid?: string

    Output only. The ID of the webhook.

  • Optionalname?: string

    Optional. The user-provided name of the webhook.

  • Optionalnew_signing_secret?: string

    Output only. The new signing secret for the webhook. Only populated on create.

  • Optionalsigning_secrets?: SigningSecret[]

    Output only. The signing secrets associated with this webhook.

  • Optionalstate?: WebhookState

    Output only. The state of the webhook.

  • subscribed_events: WebhookSubscribedEvent[]

    Required. The events that the webhook is subscribed to.

    Remarks

    Available events:

    • batch.succeeded
    • batch.expired
    • batch.failed
    • interaction.requires_action
    • interaction.completed
    • interaction.failed
    • video.generated
  • Optionalupdate_time?: string

    Output only. The timestamp when the webhook was last updated.

  • uri: string

    Required. The URI to which webhook events will be sent.

Settings