Métadonnées pour différents types de webhooks. Si vous utilisez inlineCloudFunction
, votre code source doit se trouver dans un répertoire portant le même nom que la valeur de la clé executeFunction
. Par exemple, la valeur de my_webhook
pour la clé executeFunction
présente une structure de code semblable à celle-ci: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Représentation YAML | |
---|---|
handlers: - object ( |
Champs | ||
---|---|---|
handlers[] |
Liste des gestionnaires pour ce webhook. |
|
Champ d'union webhook_type . Un seul type de webhook est accepté. webhook_type ne peut être qu'un des éléments suivants : |
||
httpsEndpoint |
Point de terminaison HTTPS du webhook personnalisé. |
|
inlineCloudFunction |
Métadonnées de la fonction Cloud déployée à partir d'un code dans le dossier des webhooks. |
Handler
Déclare le nom du gestionnaire de webhook. Un webhook peut avoir plusieurs gestionnaires enregistrés. Ces gestionnaires peuvent être appelés à partir de plusieurs emplacements dans votre projet Actions.
Représentation YAML | |
---|---|
name: string |
Champs | |
---|---|
name |
Obligatoire. Nom du gestionnaire. Doit être unique pour tous les gestionnaires du projet Actions. Vous pouvez vérifier le nom de ce gestionnaire pour appeler la fonction appropriée dans votre code source de traitement. |
HttpsEndpoint
point de terminaison REST pour vous avertir si vous n'utilisez pas l'éditeur intégré.
Représentation YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
Champs | |
---|---|
baseUrl |
L'URL de base HTTPS de votre point de terminaison de traitement (HTTP n'est pas accepté). Les noms des gestionnaires sont ajoutés au chemin de l'URL de base après le signe deux-points (conformément au guide de style disponible à l'adresse https://cloud.google.com/apis/design/custom_methods). Par exemple, l'URL de base https://gactions.service.com/api recevra des requêtes portant l'URL https://gactions.service.com/api:{method}. |
httpHeaders |
Map des paramètres HTTP à inclure dans la requête POST Objet contenant une liste de paires |
endpointApiVersion |
Version du protocole utilisé par le point de terminaison. Il s'agit du protocole partagé par tous les types de traitement, qui n'est pas spécifique au type de traitement Google. |
InlineCloudFunction
Contient les métadonnées d'une fonction Cloud intégrée déployée à partir du dossier des webhooks.
Représentation YAML | |
---|---|
executeFunction: string |
Champs | |
---|---|
executeFunction |
Nom du point d'entrée de la fonction Cloud. La valeur de ce champ doit correspondre au nom de la méthode exportée à partir du code source. |