Webhook
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Farklı webhook türleri için meta veriler. inlineCloudFunction kullanıyorsanız kaynak kodunuz, executeFunction anahtarının değeriyle aynı ada sahip bir dizinde olmalıdır. Örneğin, executeFunction anahtarı için my_webhook değeri şuna benzer bir kod yapısına sahip olur: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json
| YAML temsili |
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. |
| Alanlar |
handlers[] |
object (Handler)
Bu webhook'un işleyicilerin listesi.
|
Birleştirme alanı webhook_type. Yalnızca bir webhook türü desteklenir. webhook_type şunlardan yalnızca biri olabilir: |
httpsEndpoint |
object (HttpsEndpoint)
Özel webhook HTTPS uç noktası.
|
inlineCloudFunction |
object (InlineCloudFunction)
Webhook'lar klasöründeki koddan dağıtılan Cloud Functions işlevinin meta verileri.
|
İşleyici
Webhoook işleyicinin adını tanımlar. Bir webhook'a kayıtlı birden fazla işleyici olabilir. Bu işleyiciler, Actions projenizdeki birden fazla yerden çağrılabilir.
| YAML temsili |
name: string |
| Alanlar |
name |
string
Zorunlu. İşleyicinin adı. Actions projesindeki tüm işleyicilerde benzersiz olmalıdır. Sipariş karşılama kaynak kodunuzda doğru işlevi çağırmak için bu işleyicinin adını kontrol edebilirsiniz.
|
HttpsEndpoint
Satır içi düzenleyiciyi kullanmıyorsanız bilgilendirilecek REST uç noktası.
| YAML temsili |
baseUrl: string
httpHeaders:
string: string
endpointApiVersion: integer |
| Alanlar |
baseUrl |
string
Karşılama uç noktanız için HTTPS temel URL'si (HTTP desteklenmez). İşleyici adları, iki nokta üst üste işaretinden sonra temel URL yoluna eklenir (https://cloud.google.com/apis/design/custom_methods) adresindeki stil kılavuzu izlenerek). Örneğin, "https://gactions.service.com/api" temel URL'si "https://gactions.service.com/api:{method}" URL'sine sahip istekler alır.
|
endpointApiVersion |
integer
Uç nokta tarafından kullanılan protokolün sürümü. Bu, tüm sipariş karşılama türleri tarafından paylaşılan ve Google sipariş karşılama türüne özel olmayan protokoldür.
|
InlineCloudFunction
Webhook'lar klasöründen dağıtılan satır içi Cloud Functions işlevinin meta verilerini barındırır.
| YAML temsili |
executeFunction: string |
| Alanlar |
executeFunction |
string
Cloud Functions işlevi giriş noktasının adı. Bu alanın değeri, kaynak kodundan dışa aktarılan yöntemin adıyla eşleşmelidir.
|
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-26 UTC.
[null,null,["Son güncelleme tarihi: 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. |"]]
