Gemini Webhooks API

Les Webhooks permettent à l'API Gemini d'envoyer des notifications en temps réel à votre serveur lorsque des opérations asynchrones ou de longue durée (LRO) sont terminées. Vous n'avez donc plus besoin d'interroger l'API pour obtenir des mises à jour de l'état, ce qui réduit la latence et la surcharge.

Afficher au format Markdown Afficher la spécification OpenAPI

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

Crée un webhook.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

subscribed_events array (enum (string))  (required)

Obligatoire. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

uri string  (obligatoire)

Obligatoire. URI vers lequel les événements de webhook seront envoyés.

Réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

create_time string  (facultatif)

Uniquement en sortie. Code temporel de la création du webhook.

id chaîne  (facultatif)

Uniquement en sortie. ID du webhook.

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

new_signing_secret string  (facultatif)

Uniquement en sortie. Nouveau secret de signature pour le webhook. Renseigné uniquement lors de la création.

signing_secrets array (SigningSecret)  (facultatif)

Uniquement en sortie. Secrets de signature associés à ce webhook.

Représente un secret de signature utilisé pour valider les charges utiles de webhook.

Champs

expire_time string  (facultatif)

Uniquement en sortie. Date d'expiration du secret de signature.

truncated_secret string  (facultatif)

Uniquement en sortie. Version tronquée du secret de signature.

state enum (string)  (facultatif)

Uniquement en sortie. État du webhook.

Valeurs possibles :

  • enabled

    Le webhook est activé.

  • disabled

    Le webhook est désactivé par l'utilisateur.

  • disabled_due_to_failed_deliveries

    Le webhook est désactivé en raison d'échecs de remise.

subscribed_events array (enum (string))  (optional)

Obligatoire. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

update_time string  (facultatif)

Uniquement en sortie. Code temporel de la dernière mise à jour du webhook.

uri string  (facultatif)

Obligatoire. URI vers lequel les événements de webhook seront envoyés.

Exemple

Exemple de réponse

{
  "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

Envoie un événement ping à un webhook.

Paramètres de chemin d'accès / de requête

id chaîne  (obligatoire)

Obligatoire. ID du webhook à pinguer. Format : `{webhook_id}`

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Réponse

Si l'opération réussit, la réponse est vide.

Exemple

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Génère un nouveau secret de signature pour un webhook.

Paramètres de chemin d'accès / de requête

id chaîne  (obligatoire)

Obligatoire. ID du webhook pour lequel générer un secret de signature. Format : `{webhook_id}`

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

revocation_behavior enum (string)  (optional)

Facultatif. Comportement de révocation pour les anciens secrets de signature.

Valeurs possibles :

  • revoke_previous_secrets_after_h24

    Générez un nouveau secret de signature et révoquez tous les secrets précédents au bout de 24 heures. Option par défaut et la plus sûre pour les migrations.

  • revoke_previous_secrets_immediately

    Révoquez immédiatement tous les secrets précédents. Utilisez cette option avec prudence, car elle peut interrompre les notifications en cours.

Réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

secret string  (facultatif)

Uniquement en sortie. Le secret de signature nouvellement généré.

Exemple

Exemple de réponse

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

Liste tous les webhooks.

Paramètres de chemin d'accès / de requête

page_size integer  (facultatif)

Facultatif. Nombre maximal de webhooks à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 webhooks au maximum sont renvoyés. La valeur maximale est de 1 000.

page_token string  (facultatif)

Facultatif. Jeton de page reçu d'un appel "ListWebhooks" précédent. Fournissez-le pour récupérer la page suivante.

Réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

next_page_token string  (facultatif)

Jeton pouvant être envoyé en tant que "page_token" pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

webhooks array (Webhook)  (facultatif)

Webhooks.

Exemple

Exemple de réponse

{
  "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}

Récupère un webhook spécifique.

Paramètres de chemin d'accès / de requête

id chaîne  (obligatoire)

Obligatoire. ID du webhook à récupérer.

Réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

create_time string  (facultatif)

Uniquement en sortie. Code temporel de la création du webhook.

id chaîne  (facultatif)

Uniquement en sortie. ID du webhook.

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

new_signing_secret string  (facultatif)

Uniquement en sortie. Nouveau secret de signature pour le webhook. Renseigné uniquement lors de la création.

signing_secrets array (SigningSecret)  (facultatif)

Uniquement en sortie. Secrets de signature associés à ce webhook.

Représente un secret de signature utilisé pour valider les charges utiles de webhook.

Champs

expire_time string  (facultatif)

Uniquement en sortie. Date d'expiration du secret de signature.

truncated_secret string  (facultatif)

Uniquement en sortie. Version tronquée du secret de signature.

state enum (string)  (facultatif)

Uniquement en sortie. État du webhook.

Valeurs possibles :

  • enabled

    Le webhook est activé.

  • disabled

    Le webhook est désactivé par l'utilisateur.

  • disabled_due_to_failed_deliveries

    Le webhook est désactivé en raison d'échecs de remise.

subscribed_events array (enum (string))  (optional)

Obligatoire. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

update_time string  (facultatif)

Uniquement en sortie. Code temporel de la dernière mise à jour du webhook.

uri string  (facultatif)

Obligatoire. URI vers lequel les événements de webhook seront envoyés.

Exemple

Exemple de réponse

{
  "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}

Met à jour un webhook existant.

Paramètres de chemin d'accès / de requête

id chaîne  (obligatoire)

Obligatoire. ID du webhook à mettre à jour.

update_mask string  (facultatif)

Facultatif. Liste des champs à mettre à jour.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

state enum (string)  (facultatif)

Facultatif. État du webhook.

Valeurs possibles :

  • enabled

    Le webhook est activé.

  • disabled

    Le webhook est désactivé par l'utilisateur.

  • disabled_due_to_failed_deliveries

    Le webhook est désactivé en raison d'échecs de remise.

subscribed_events array (enum (string))  (optional)

Facultatif. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

uri string  (facultatif)

Facultatif. URI vers lequel les événements de webhook seront envoyés.

Réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

create_time string  (facultatif)

Uniquement en sortie. Code temporel de la création du webhook.

id chaîne  (facultatif)

Uniquement en sortie. ID du webhook.

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

new_signing_secret string  (facultatif)

Uniquement en sortie. Nouveau secret de signature pour le webhook. Renseigné uniquement lors de la création.

signing_secrets array (SigningSecret)  (facultatif)

Uniquement en sortie. Secrets de signature associés à ce webhook.

Représente un secret de signature utilisé pour valider les charges utiles de webhook.

Champs

expire_time string  (facultatif)

Uniquement en sortie. Date d'expiration du secret de signature.

truncated_secret string  (facultatif)

Uniquement en sortie. Version tronquée du secret de signature.

state enum (string)  (facultatif)

Uniquement en sortie. État du webhook.

Valeurs possibles :

  • enabled

    Le webhook est activé.

  • disabled

    Le webhook est désactivé par l'utilisateur.

  • disabled_due_to_failed_deliveries

    Le webhook est désactivé en raison d'échecs de remise.

subscribed_events array (enum (string))  (optional)

Obligatoire. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

update_time string  (facultatif)

Uniquement en sortie. Code temporel de la dernière mise à jour du webhook.

uri string  (facultatif)

Obligatoire. URI vers lequel les événements de webhook seront envoyés.

Exemple

Exemple de réponse

{
  "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}

Supprime un webhook.

Paramètres de chemin d'accès / de requête

id chaîne  (obligatoire)

Obligatoire. ID du webhook à supprimer. Format : `{webhook_id}`

Réponse

Si l'opération réussit, la réponse est vide.

Exemple

Ressources

Webhook

Ressource Webhook.

Champs

create_time string  (facultatif)

Uniquement en sortie. Code temporel de la création du webhook.

id chaîne  (facultatif)

Uniquement en sortie. ID du webhook.

name string  (facultatif)

Facultatif. Nom du webhook fourni par l'utilisateur.

new_signing_secret string  (facultatif)

Uniquement en sortie. Nouveau secret de signature pour le webhook. Renseigné uniquement lors de la création.

signing_secrets array (SigningSecret)  (facultatif)

Uniquement en sortie. Secrets de signature associés à ce webhook.

Représente un secret de signature utilisé pour valider les charges utiles de webhook.

Champs

expire_time string  (facultatif)

Uniquement en sortie. Date d'expiration du secret de signature.

truncated_secret string  (facultatif)

Uniquement en sortie. Version tronquée du secret de signature.

state enum (string)  (facultatif)

Uniquement en sortie. État du webhook.

Valeurs possibles :

  • enabled

    Le webhook est activé.

  • disabled

    Le webhook est désactivé par l'utilisateur.

  • disabled_due_to_failed_deliveries

    Le webhook est désactivé en raison d'échecs de remise.

subscribed_events array (enum (string))  (optional)

Obligatoire. Événements auxquels le webhook est abonné. Événements disponibles : - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Valeurs possibles :

  • batch.succeeded

    Le traitement par lot a bien été effectué.

  • batch.expired

    Le lot n'a pas été traité dans le délai de 48 heures.

  • batch.failed

    Échec du job par lot.

  • interaction.requires_action

    L'interaction nécessite une action (par exemple, un appel de fonction).

  • interaction.completed

    L'interaction s'est bien terminée.

  • interaction.failed

    L'interaction a échoué.

  • video.generated

    La vidéo a été générée.

update_time string  (facultatif)

Uniquement en sortie. Code temporel de la dernière mise à jour du webhook.

uri string  (facultatif)

Obligatoire. URI vers lequel les événements de webhook seront envoyés.