Metadane dla różnych typów webhooków. Jeśli używasz inlineCloudFunction
, Twój kod źródłowy musi znajdować się w katalogu o tej samej nazwie co wartość klucza executeFunction
. Na przykład wartość my_webhook
klucza executeFunction
miałaby taką strukturę kodu: – /webhooks/my_webhook.yaml
– /webhooks/my_webhook/index.js
– /webhooks/my_webhook/package.json
Reprezentacja YAML | |
---|---|
handlers: - object ( |
Pola | ||
---|---|---|
handlers[] |
Lista modułów obsługi tego webhooka. |
|
Pole sumy webhook_type . Obsługiwany jest tylko jeden typ webhooka. webhook_type może mieć tylko jedną z tych wartości: |
||
httpsEndpoint |
Niestandardowy punkt końcowy HTTPS webhooka. |
|
inlineCloudFunction |
Metadane dla funkcji w Cloud Functions wdrożonej z kodu w folderze webhooków. |
Moduł obsługi
Deklaruje nazwę modułu obsługi webhoook. Webhook może mieć zarejestrowanych wiele modułów obsługi. Te moduły obsługi można wywoływać z różnych miejsc w projekcie Actions.
Reprezentacja YAML | |
---|---|
name: string |
Pola | |
---|---|
name |
To pole jest wymagane. Nazwa modułu obsługi. Musi być niepowtarzalna wśród wszystkich modułów obsługi w projekcie Actions. Możesz sprawdzić nazwę tego modułu obsługi, aby wywołać odpowiednią funkcję w kodzie źródłowym realizacji. |
HttpsEndpoint
Punkt końcowy REST do powiadamiania, jeśli nie używasz edytora wbudowanego.
Reprezentacja YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
Pola | |
---|---|
baseUrl |
Podstawowy adres URL HTTPS dla punktu końcowego realizacji (HTTP nie jest obsługiwany). Nazwy modułów obsługi są dodawane do podstawowej ścieżki adresu URL po dwukropku (zgodnie ze stylem podanym na stronie https://cloud.google.com/apis/design/custom_methods)). Na przykład podstawowy adres URL „https://gactions.service.com/api” będzie otrzymywał żądania z adresem URL „https://gactions.service.com/api:{method}”. |
httpHeaders |
Mapa parametrów HTTP, które mają być uwzględnione w żądaniu POST. Obiekt zawierający listę par |
endpointApiVersion |
Wersja protokołu używanego przez punkt końcowy. Jest to protokół wspólny dla wszystkich typów realizacji zamówień, który nie jest związany z typem realizacji Google. |
InlineCloudFunction
Zawiera metadane wbudowanej funkcji w Cloud Functions wdrożonej z folderu webhooków.
Reprezentacja YAML | |
---|---|
executeFunction: string |
Pola | |
---|---|
executeFunction |
Nazwa punktu wejścia funkcji w Cloud Functions. Wartość w tym polu powinna odpowiadać nazwie metody wyeksportowanej z kodu źródłowego. |