Webhook
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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 folgende Codestruktur: – /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-Funktionen, die aus Code im Ordner „Webhooks“ bereitgestellt werden.
|
Handler
Deklariert den Namen des Webhook-Handlers. Für einen Webhook können mehrere Handler registriert sein. Diese Handler können von mehreren 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 überprüfen, um die richtige Funktion in Ihrem Quellcode für die Auftragsausführung aufzurufen.
|
HttpsEndpoint
REST-Endpunkt zur Benachrichtigung, wenn Sie den Inline-Editor nicht verwenden.
YAML-Darstellung |
baseUrl: string
httpHeaders:
string: string
endpointApiVersion: integer |
Felder |
baseUrl |
string
Die HTTPS-Basis-URL für Ihren Auftragsausführungsendpunkt (HTTP wird nicht unterstützt). Handler-Namen werden gemäß dem Styleguide unter https://cloud.google.com/apis/design/custom_methods) nach einem Doppelpunkt an den Basis-URL-Pfad angehängt. Beispiel: Die Basis-URL „https://gactions.service.com/api“ würde Anfragen mit der URL „https://gactions.service.com/api:{method}“ empfangen.
|
endpointApiVersion |
integer
Version des vom Endpunkt verwendeten Protokolls. Dies ist das Protokoll, das von allen Auftragsausführungstypen gemeinsam verwendet wird und nicht spezifisch für den Google-Auftragsausführungstyp.
|
InlineCloudFunction
Enthält die Metadaten einer Inline-Cloud Functions-Funktion, die aus dem Webhook-Ordner bereitgestellt wird.
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.
|
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eWebhooks use YAML to define metadata for different handler types like HTTPS endpoints and inline Cloud Functions.\u003c/p\u003e\n"],["\u003cp\u003eInline Cloud Functions require source code in a directory matching the \u003ccode\u003eexecuteFunction\u003c/code\u003e value.\u003c/p\u003e\n"],["\u003cp\u003eHandlers specify the webhook's name and can be invoked from various points in your Actions project.\u003c/p\u003e\n"],["\u003cp\u003eHTTPS endpoints define the base URL and optional HTTP headers for external fulfillment.\u003c/p\u003e\n"],["\u003cp\u003eInline Cloud Functions use the \u003ccode\u003eexecuteFunction\u003c/code\u003e field to identify the entry point in your source code.\u003c/p\u003e\n"]]],[],null,["# Webhook\n\n- [YAML representation](#SCHEMA_REPRESENTATION)\n- [Handler](#Handler)\n - [YAML representation](#Handler.SCHEMA_REPRESENTATION)\n- [HttpsEndpoint](#HttpsEndpoint)\n - [YAML representation](#HttpsEndpoint.SCHEMA_REPRESENTATION)\n- [InlineCloudFunction](#InlineCloudFunction)\n - [YAML representation](#InlineCloudFunction.SCHEMA_REPRESENTATION)\n\nMetadata for different types of webhooks. If you're using `inlineCloudFunction`, your source code must be in a directory with the same name as the value for the `executeFunction` key. For example, a value of `my_webhook` for the`executeFunction` key would have a code structure like this: - `/webhooks/my_webhook.yaml` - `/webhooks/my_webhook/index.js` - `/webhooks/my_webhook/package.json`\n\n| YAML representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` handlers: - object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#Handler) # Union field `webhook_type` can be only one of the following: httpsEndpoint: object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#HttpsEndpoint) inlineCloudFunction: object (/assistant/actionssdk/reference/rest/Shared.Types/Webhook#InlineCloudFunction) # End of list of possible types for union field `webhook_type`. ``` |\n\n| Fields ||\n|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `handlers[]` | `object (`[Handler](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#Handler)`)` List of handlers for this webhook. |\n| Union field `webhook_type`. Only one webhook type is supported. `webhook_type` can be only one of the following: |||\n| `httpsEndpoint` | `object (`[HttpsEndpoint](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#HttpsEndpoint)`)` Custom webhook HTTPS endpoint. |\n| `inlineCloudFunction` | `object (`[InlineCloudFunction](/assistant/actionssdk/reference/rest/Shared.Types/Webhook#InlineCloudFunction)`)` Metadata for cloud function deployed from code in the webhooks folder. |\n\nHandler\n-------\n\nDeclares the name of the webhoook handler. A webhook can have multiple handlers registered. These handlers can be called from multiple places in your Actions project.\n\n| YAML representation ||\n|----------------------|---|\n| ``` name: string ``` |\n\n| Fields ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Name of the handler. Must be unique across all handlers the Actions project. You can check the name of this handler to invoke the correct function in your fulfillment source code. |\n\nHttpsEndpoint\n-------------\n\nREST endpoint to notify if you're not using the inline editor.\n\n| YAML representation ||\n|---------------------------------------------------------------------------------|---|\n| ``` baseUrl: string httpHeaders: string: string endpointApiVersion: integer ``` |\n\n| Fields ||\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `baseUrl` | `string` The HTTPS base URL for your fulfillment endpoint (HTTP is not supported). Handler names are appended to the base URL path after a colon (following the style guide in \u003chttps://cloud.google.com/apis/design/custom_methods)\u003e. For example a base URL of 'https://gactions.service.com/api' would receive requests with URL 'https://gactions.service.com/api:{method}'. |\n| `httpHeaders` | `map (key: string, value: string)` Map of HTTP parameters to be included in the POST request. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `endpointApiVersion` | `integer` Version of the protocol used by the endpoint. This is the protocol shared by all fulfillment types and not specific to Google fulfillment type. |\n\nInlineCloudFunction\n-------------------\n\nHolds the metadata of an inline Cloud Function deployed from the webhooks folder.\n\n| YAML representation ||\n|---------------------------------|---|\n| ``` executeFunction: string ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `executeFunction` | `string` The name of the Cloud Function entry point. The value of this field should match the name of the method exported from the source code. |"]]