Webhook

Metadaten für verschiedene Arten von Webhooks. Wenn Sie inlineCloudFunction verwenden, muss sich der Quellcode in einem Verzeichnis mit demselben Namen wie der Wert für den Schlüssel executeFunction befinden. Ein Wert von my_webhook für den Schlüssel executeFunction hätte beispielsweise eine Codestruktur wie diese: – /webhooks/my_webhook.yaml/webhooks/my_webhook/index.js/webhooks/my_webhook/package.json

YAML-Darstellung
handlers: 
  - object (Handler)

# Union field webhook_type can be only one of the following:
httpsEndpoint: 
  object (HttpsEndpoint)
inlineCloudFunction: 
  object (InlineCloudFunction)
# End of list of possible types for union field webhook_type.
Felder
handlers[]

object (Handler)

Liste der Handler für diesen Webhook.

Union-Feld webhook_type. Es wird nur ein Webhook-Typ unterstützt. Für webhook_type ist nur einer der folgenden Werte zulässig:
httpsEndpoint

object (HttpsEndpoint)

Benutzerdefinierter Webhook-HTTPS-Endpunkt.

inlineCloudFunction

object (InlineCloudFunction)

Metadaten für Cloud Functions, die aus Code im Webhook-Ordner bereitgestellt werden.

Handler

Deklariert den Namen des Webhook-Handlers. Für einen Webhook können mehrere Handler registriert sein. Diese Handler können von verschiedenen Stellen in Ihrem Actions-Projekt aus aufgerufen werden.

YAML-Darstellung
name: string
Felder
name

string

Erforderlich. Name des Handlers. Muss für alle Handler im Actions-Projekt eindeutig sein. Sie können den Namen dieses Handlers prüfen, um die richtige Funktion im Quellcode der Auftragsausführung aufzurufen.

HttpsEndpoint

REST-Endpunkt, um eine Benachrichtigung zu senden, wenn Sie nicht den Inline-Editor verwenden.

YAML-Darstellung
baseUrl: string
httpHeaders: 
  string: string
endpointApiVersion: integer
Felder
baseUrl

string

Die HTTPS-Basis-URL des Endpunkts der Auftragsausführung (HTTP wird nicht unterstützt). Handler-Namen werden nach einem Doppelpunkt an den Basis-URL-Pfad angehängt (gemäß dem Styleguide unter https://cloud.google.com/apis/design/custom_methods). Beispielsweise würde die Basis-URL „https://gactions.service.com/api“ Anfragen mit der URL „https://gactions.service.com/api:{method}“ empfangen.

httpHeaders

map (key: string, value: string)

Zuordnung der HTTP-Parameter, die in die POST-Anfrage aufgenommen werden sollen.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

endpointApiVersion

integer

Version des Protokolls, das vom Endpunkt verwendet wird. Dies ist das Protokoll, das von allen Auftragsausführungstypen verwendet wird, und ist nicht spezifisch für den Google-Auftragsausführungstyp.

InlineCloudFunction

Enthält die Metadaten einer Cloud Functions-Inline-Funktion, die aus dem Webhook-Ordner bereitgestellt wurde.

YAML-Darstellung
executeFunction: string
Felder
executeFunction

string

Der Name des Cloud Functions-Einstiegspunkts. Der Wert in diesem Feld sollte mit dem Namen der Methode übereinstimmen, die aus dem Quellcode exportiert wurde.