Interface Webhook

A Webhook resource.

interface Webhook {
    create_time?: string;
    name?: string;
    new_signing_secret?: string;
    signing_secrets?: GeminiNextGenAPIClient.Webhooks.SigningSecret[];
    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"
    )[];
    update_time?: string;
    uri: string;
}

Properties

create_time? name? new_signing_secret? signing_secrets? state? subscribed_events update_time? uri

Properties

Optionalcreate_time

create_time?: string

Output only. The timestamp when the webhook was created.

Optionalname

name?: string

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

Optionalnew_signing_secret

new_signing_secret?: string

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

Optionalsigning_secrets

signing_secrets?: GeminiNextGenAPIClient.Webhooks.SigningSecret[]

Output only. The signing secrets associated with this webhook.

Optionalstate

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

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"
)[]

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

Optionalupdate_time

update_time?: string

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

uri

uri: string

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

Settings

On This Page

Properties