Gemini Webhooks API  |  Gemini API  |  Google AI for Developers
Skip to main content
/
English
Deutsch
Español – América Latina
Français
Indonesia
Italiano
Polski
Português – Brasil
Shqip
Tiếng Việt
Türkçe
Русский
עברית
العربيّة
فارسی
हिंदी
বাংলা
ภาษาไทย
中文 – 简体
中文 – 繁體
日本語
한국어
Get API key
Cookbook
Community
Sign in
Docs
API reference
Gemini API
Docs
API reference
Get API key
Cookbook
Community
Overview
API versions
Core APIs
Interactions API
GenerateContent
Real time APIs
Live API
Live Music API
Platform APIs
Model API
Agents
Webhooks
Triggers
Batch API
Files API
Tokens
Caching
Embeddings
File Search API
File search stores
Documents
All methods
SDK references
Python
Go
TypeScript
Java
C#
The Interactions API is now generally available. We recommend using this API for access to all the latest features and models.
Home
Gemini API
API reference
Send feedback
Gemini Webhooks API
Beta: This API is in Beta. Endpoints are under /v1beta/.
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.
View as markdown
View the OpenAPI Spec
CreateWebhook
post
https://generativelanguage.googleapis.com/v1beta/webhooks
Creates a new Webhook.
Request body
Response
Request body
The request body contains data with the following structure:
name
string
 (optional)
Optional. The user-provided name of the webhook.
subscribed_events
array (enum (string))
 (required)
Required. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
uri
string
 (required)
Required. The URI to which webhook events will be sent.
Response
If successful, the response body contains data with the following structure:
create_time
string
 (optional)
Output only. The timestamp when the webhook was created.
id
string
 (optional)
Output only. The ID of the webhook.
name
string
 (optional)
Optional. The user-provided name of the webhook.
new_signing_secret
string
 (optional)
Output only. The new signing secret for the webhook. Only populated on create.
signing_secrets
SigningSecret
 (optional)
Output only. The signing secrets associated with this webhook.
Represents a signing secret used to verify webhook payloads.
Fields
expire_time
string
 (optional)
Output only. The expiration date of the signing secret.
truncated_secret
string
 (optional)
Output only. The truncated version of the signing secret.
state
enum (string)
 (optional)
Output only. The state of the webhook.
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.
subscribed_events
array (enum (string))
 (optional)
Required. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
update_time
string
 (optional)
Output only. The timestamp when the webhook was last updated.
uri
string
 (optional)
Required. The URI to which webhook events will be sent.
Example
Example Response
{
"create_time": "string",
"id": "string",
"name": "string",
"new_signing_secret": "string",
"signing_secrets": [
{
"expire_time": "string",
"truncated_secret": "string"
}
],
"state": "enabled",
"subscribed_events": [
"batch.succeeded"
],
"update_time": "string",
"uri": "string"
}
PingWebhook
post
https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping
Sends a ping event to a Webhook.
Path / Query parameters
Request body
Response
Path / Query Parameters
id
string
 (required)
Required. The ID of the webhook to ping.
Format: `{webhook_id}`
Request body
The request body contains data with the following structure:
Response
If successful, the response is empty.
Example
RotateSigningSecret
post
https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret
Generates a new signing secret for a Webhook.
Path / Query parameters
Request body
Response
Path / Query Parameters
id
string
 (required)
Required. The ID of the webhook for which to generate a signing secret.
Format: `{webhook_id}`
Request body
The request body contains data with the following structure:
revocation_behavior
enum (string)
 (optional)
Optional. The revocation behavior for previous signing secrets.
Possible
values:
revoke_previous_secrets_after_h24
Generate a new signing secret and revoke all previous secrets after 24
hours. Default and safest option for migrations.
revoke_previous_secrets_immediately
Revoke all previous secrets immediately. Use with caution as this can
interrupt ongoing notifications.
Response
If successful, the response body contains data with the following structure:
secret
string
 (optional)
Output only. The newly generated signing secret.
Example
Example Response
{
"secret": "string"
}
ListWebhooks
get
https://generativelanguage.googleapis.com/v1beta/webhooks
Lists all Webhooks.
Path / Query parameters
Response
Path / Query Parameters
page_size
integer
 (optional)
Optional. The maximum number of webhooks to return. The service may return fewer than
this value. If unspecified, at most 50 webhooks will be returned.
The maximum value is 1000.
page_token
string
 (optional)
Optional. A page token, received from a previous `ListWebhooks` call.
Provide this to retrieve the subsequent page.
Response
If successful, the response body contains data with the following structure:
next_page_token
string
 (optional)
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
webhooks
array (Webhook)
 (optional)
The webhooks.
Example
Example Response
{
"next_page_token": "string",
"webhooks": [
{
"create_time": "string",
"id": "string",
"name": "string",
"new_signing_secret": "string",
"signing_secrets": [
{
"expire_time": "string",
"truncated_secret": "string"
}
],
"state": "enabled",
"subscribed_events": [
"batch.succeeded"
],
"update_time": "string",
"uri": "string"
}
]
}
GetWebhook
get
https://generativelanguage.googleapis.com/v1beta/webhooks/{id}
Gets a specific Webhook.
Path / Query parameters
Response
Path / Query Parameters
id
string
 (required)
Required. The ID of the webhook to retrieve.
Response
If successful, the response body contains data with the following structure:
create_time
string
 (optional)
Output only. The timestamp when the webhook was created.
id
string
 (optional)
Output only. The ID of the webhook.
name
string
 (optional)
Optional. The user-provided name of the webhook.
new_signing_secret
string
 (optional)
Output only. The new signing secret for the webhook. Only populated on create.
signing_secrets
SigningSecret
 (optional)
Output only. The signing secrets associated with this webhook.
Represents a signing secret used to verify webhook payloads.
Fields
expire_time
string
 (optional)
Output only. The expiration date of the signing secret.
truncated_secret
string
 (optional)
Output only. The truncated version of the signing secret.
state
enum (string)
 (optional)
Output only. The state of the webhook.
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.
subscribed_events
array (enum (string))
 (optional)
Required. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
update_time
string
 (optional)
Output only. The timestamp when the webhook was last updated.
uri
string
 (optional)
Required. The URI to which webhook events will be sent.
Example
Example Response
{
"create_time": "string",
"id": "string",
"name": "string",
"new_signing_secret": "string",
"signing_secrets": [
{
"expire_time": "string",
"truncated_secret": "string"
}
],
"state": "enabled",
"subscribed_events": [
"batch.succeeded"
],
"update_time": "string",
"uri": "string"
}
UpdateWebhook
patch
https://generativelanguage.googleapis.com/v1beta/webhooks/{id}
Updates an existing Webhook.
Path / Query parameters
Request body
Response
Path / Query Parameters
id
string
 (required)
Required. The ID of the webhook to update.
update_mask
string
 (optional)
Optional. The list of fields to update.
Request body
The request body contains data with the following structure:
name
string
 (optional)
Optional. The user-provided name of the webhook.
state
enum (string)
 (optional)
Optional. The state of the webhook.
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.
subscribed_events
array (enum (string))
 (optional)
Optional. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
uri
string
 (optional)
Optional. The URI to which webhook events will be sent.
Response
If successful, the response body contains data with the following structure:
create_time
string
 (optional)
Output only. The timestamp when the webhook was created.
id
string
 (optional)
Output only. The ID of the webhook.
name
string
 (optional)
Optional. The user-provided name of the webhook.
new_signing_secret
string
 (optional)
Output only. The new signing secret for the webhook. Only populated on create.
signing_secrets
SigningSecret
 (optional)
Output only. The signing secrets associated with this webhook.
Represents a signing secret used to verify webhook payloads.
Fields
expire_time
string
 (optional)
Output only. The expiration date of the signing secret.
truncated_secret
string
 (optional)
Output only. The truncated version of the signing secret.
state
enum (string)
 (optional)
Output only. The state of the webhook.
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.
subscribed_events
array (enum (string))
 (optional)
Required. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
update_time
string
 (optional)
Output only. The timestamp when the webhook was last updated.
uri
string
 (optional)
Required. The URI to which webhook events will be sent.
Example
Example Response
{
"create_time": "string",
"id": "string",
"name": "string",
"new_signing_secret": "string",
"signing_secrets": [
{
"expire_time": "string",
"truncated_secret": "string"
}
],
"state": "enabled",
"subscribed_events": [
"batch.succeeded"
],
"update_time": "string",
"uri": "string"
}
DeleteWebhook
delete
https://generativelanguage.googleapis.com/v1beta/webhooks/{id}
Deletes a Webhook.
Path / Query parameters
Response
Path / Query Parameters
id
string
 (required)
Required. The ID of the webhook to delete.
Format: `{webhook_id}`
Response
If successful, the response is empty.
Example
Resources
Webhook
A Webhook resource.
Fields
create_time
string
 (optional)
Output only. The timestamp when the webhook was created.
id
string
 (optional)
Output only. The ID of the webhook.
name
string
 (optional)
Optional. The user-provided name of the webhook.
new_signing_secret
string
 (optional)
Output only. The new signing secret for the webhook. Only populated on create.
signing_secrets
SigningSecret
 (optional)
Output only. The signing secrets associated with this webhook.
Represents a signing secret used to verify webhook payloads.
Fields
expire_time
string
 (optional)
Output only. The expiration date of the signing secret.
truncated_secret
string
 (optional)
Output only. The truncated version of the signing secret.
state
enum (string)
 (optional)
Output only. The state of the webhook.
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.
subscribed_events
array (enum (string))
 (optional)
Required. 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
Possible
values:
batch.succeeded
Batch processing finished successfully.
batch.expired
Batch has not been processed within the 48h timeframe.
batch.failed
Batch job failed.
interaction.requires_action
Interaction requires action (e.g., function calling).
interaction.completed
Interaction completed successfully.
interaction.failed
Interaction failed.
video.generated
Video generation completed.
update_time
string
 (optional)
Output only. The timestamp when the webhook was last updated.
uri
string
 (optional)
Required. The URI to which webhook events will be sent.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-07-15 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-07-15 UTC."],[],[]]
Terms
Privacy
Manage cookies
English
Deutsch
Español – América Latina
Français
Indonesia
Italiano
Polski
Português – Brasil
Shqip
Tiếng Việt
Türkçe
Русский
עברית
العربيّة
فارسی
हिंदी
বাংলা
ภาษาไทย
中文 – 简体
中文 – 繁體
日本語
한국어