Webhook
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Metadati per diversi tipi di webhook. Se utilizzi inlineCloudFunction, il codice sorgente deve trovarsi in una directory con lo stesso nome del valore della chiave executeFunction. Ad esempio, un valore my_webhook per la chiave executeFunction avrebbe una struttura di codice simile alla seguente: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json
| Rappresentazione YAML |
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. |
| Campi |
handlers[] |
object (Handler)
Elenco di gestori per questo webhook.
|
Campo unione webhook_type. È supportato un solo tipo di webhook. webhook_type può essere solo uno dei seguenti: |
httpsEndpoint |
object (HttpsEndpoint)
Endpoint HTTPS del webhook personalizzato.
|
inlineCloudFunction |
object (InlineCloudFunction)
Metadati per la funzione Cloud Functions di cui è stato eseguito il deployment dal codice nella cartella webhooks.
|
Handler
Dichiara il nome del gestore webhoook. In un webhook possono essere registrati più gestori. Questi gestori possono essere chiamati da più posizioni nel tuo progetto Actions.
| Rappresentazione YAML |
name: string |
| Campi |
name |
string
Obbligatorio. Nome del gestore. Deve essere univoco in tutti i gestori del progetto Actions. Puoi controllare il nome di questo gestore per richiamare la funzione corretta nel codice sorgente di fulfillment.
|
HttpsEndpoint
Endpoint REST per inviare una notifica se non utilizzi l'editor in linea.
| Rappresentazione YAML |
baseUrl: string
httpHeaders:
string: string
endpointApiVersion: integer |
| Campi |
baseUrl |
string
L'URL di base HTTPS dell'endpoint di fulfillment (HTTP non è supportato). I nomi dei gestori vengono aggiunti al percorso dell'URL di base dopo i due punti (seguendo la guida di stile in https://cloud.google.com/apis/design/custom_methods). Ad esempio, un URL di base di "https://gactions.service.com/api" riceverebbe richieste con l'URL "https://gactions.service.com/api:{method}".
|
endpointApiVersion |
integer
Versione del protocollo utilizzato dall'endpoint. Questo è il protocollo condiviso da tutti i tipi di distribuzione e non è specifico per il tipo di completamento Google.
|
InlineCloudFunction
Contiene i metadati di una funzione Cloud Functions in linea di cui è stato eseguito il deployment dalla cartella webhook.
| Rappresentazione YAML |
executeFunction: string |
| Campi |
executeFunction |
string
Il nome del punto di ingresso della funzione Cloud Functions. Il valore di questo campo deve corrispondere al nome del metodo esportato dal codice sorgente.
|
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-26 UTC.
[null,null,["Ultimo aggiornamento 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. |"]]
