> ## AI Agent Context
> Get the complete documentation index at: https://aistudio.google.com/llms.txt
> Use this file to discover all available pages.
> For the full documentation in a single file, fetch: https://aistudio.google.com/llms-full.txt

# Gemini Webhooks API

{% callout type="note" %}
  This API is in Beta. Endpoints are under `/v1beta/`.

{% /callout %}

Webhooks allow the Gemini API to push real-time notifications to your server when asynchronous or Long-Running Operations (LROs) complete. This replaces the need to poll the API for status updates, reducing latency and overhead.

## Methods  {% id="methods" %}

{% table %}
  * Method
  * HTTP request

  ---

  * [Creating a webhook](/api-reference/webhooks/create-webhook)
  *     {% mark class="http-post" %}{% icon name="north_east" /%}`POST`{% /mark %} `/v1beta/webhooks`

    Creates a new Webhook.


  ---

  * [Pinging a webhook](/api-reference/webhooks/ping-webhook)
  *     {% mark class="http-post" %}{% icon name="north_east" /%}`POST`{% /mark %} `/v1beta/webhooks/{id}:ping`

    Sends a ping event to a Webhook.


  ---

  * [Rotating a webhook signing secret](/api-reference/webhooks/rotate-signing-secret)
  *     {% mark class="http-post" %}{% icon name="north_east" /%}`POST`{% /mark %} `/v1beta/webhooks/{id}:rotateSigningSecret`

    Generates a new signing secret for a Webhook.


  ---

  * [Listing webhooks](/api-reference/webhooks/list-webhooks)
  *     {% mark class="http-get" %}{% icon name="south_west" /%}`GET`{% /mark %} `/v1beta/webhooks`

    Lists all Webhooks.


  ---

  * [Getting a webhook](/api-reference/webhooks/get-webhook)
  *     {% mark class="http-get" %}{% icon name="south_west" /%}`GET`{% /mark %} `/v1beta/webhooks/{id}`

    Gets a specific Webhook.


  ---

  * [Updating a webhook](/api-reference/webhooks/update-webhook)
  *     {% mark class="http-patch" %}{% icon name="north_east" /%}`PATCH`{% /mark %} `/v1beta/webhooks/{id}`

    Updates an existing Webhook.


  ---

  * [Deleting a webhook](/api-reference/webhooks/delete-webhook)
  *     {% mark class="http-delete" %}{% icon name="close" /%}`DELETE`{% /mark %} `/v1beta/webhooks/{id}`

    Deletes a Webhook.

{% /table %}

## Resources  {% id="resources" %}

### Webhook  {% id="Resource:Webhook" %}

A Webhook resource.

**Properties:**

{% section class="api-ref-property-list" %}
  **uri**: {% mark %}required{% /mark %} `string`

  The URI to which webhook events will be sent.

  {% hr /%}

  **subscribed_events**: {% mark %}required{% /mark %} `string array`

  The events that the webhook is subscribed to. Available events:

  - batch.succeeded
  - batch.expired
  - batch.failed
  - interaction.requires_action
  - interaction.completed
  - interaction.failed
  - video.generated

  {% hr /%}

  **name**: `string`

  Optional. The user-provided name of the webhook.

  {% hr /%}

  **create_time**: `string`

  Output only. The timestamp when the webhook was created.

  {% hr /%}

  **update_time**: `string`

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

  {% hr /%}

  {% details %}
  {% summary %}
  **signing_secrets**: `SigningSecret array`

  Output only. The signing secrets associated with this webhook.

  {% /summary %}

  **truncated_secret**: `string`

  Output only. The truncated version of the signing secret.

  **expire_time**: `string`

  Output only. The expiration date of the signing secret.

  {% /details %}

  {% hr /%}

  {% details %}
  {% summary %}
  **state**: `string enum`

  Output only. The state of the webhook.

  {% /summary %}

  Possible values:

  - `enabled`: The webhook is enabled.
  - `disabled`: The webhook is disabled by the user.
  - `disabled_due_to_failed_deliveries`: The webhook is disabled due to failed deliveries.

  {% /details %}

  {% hr /%}

  **new_signing_secret**: `string`

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

  {% hr /%}

  **id**: `string`

  Output only. The ID of the webhook.

{% /section %}

