Metadata untuk berbagai jenis webhook. Jika Anda menggunakan inlineCloudFunction
, kode sumber harus berada di direktori dengan nama yang sama dengan nilai untuk kunci executeFunction
. Misalnya, nilai my_webhook
untuk kunci executeFunction
akan memiliki struktur kode seperti ini: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representasi YAML | |
---|---|
handlers: - object ( |
Kolom | ||
---|---|---|
handlers[] |
Daftar pengendali untuk webhook ini. |
|
Kolom union webhook_type . Hanya satu jenis webhook yang didukung. webhook_type hanya dapat berupa salah satu dari berikut: |
||
httpsEndpoint |
Endpoint HTTPS webhook kustom. |
|
inlineCloudFunction |
Metadata untuk fungsi cloud yang di-deploy dari kode di folder webhook. |
Handler
Mendeklarasikan nama pengendali webhoook. Webhook dapat memiliki beberapa pengendali yang terdaftar. Pengendali ini dapat dipanggil dari beberapa tempat di project Action Anda.
Representasi YAML | |
---|---|
name: string |
Kolom | |
---|---|
name |
Wajib diisi. Nama pengendali. Harus unik di semua pengendali project Actions. Anda dapat memeriksa nama pengendali ini untuk memanggil fungsi yang benar dalam kode sumber fulfillment Anda. |
HttpsEndpoint
Endpoint REST untuk memberi tahu jika Anda tidak menggunakan editor inline.
Representasi YAML | |
---|---|
baseUrl: string httpHeaders: string: string endpointApiVersion: integer |
Kolom | |
---|---|
baseUrl |
URL dasar HTTPS untuk endpoint fulfillment Anda (HTTP tidak didukung). Nama pengendali ditambahkan ke jalur URL dasar setelah tanda titik dua (dengan mengikuti panduan gaya di https://cloud.google.com/apis/design/custom_methods). Misalnya, URL dasar 'https://gactions.service.com/api' akan menerima permintaan dengan URL 'https://gactions.service.com/api:{method}'. |
httpHeaders |
Peta parameter HTTP yang akan disertakan dalam permintaan POST. Objek yang berisi daftar pasangan |
endpointApiVersion |
Versi protokol yang digunakan oleh endpoint. Ini adalah protokol yang digunakan bersama oleh semua jenis fulfillment dan tidak spesifik untuk jenis fulfillment Google. |
InlineCloudFunction
Menyimpan metadata Cloud Function inline yang di-deploy dari folder webhook.
Representasi YAML | |
---|---|
executeFunction: string |
Kolom | |
---|---|
executeFunction |
Nama titik entri Cloud Function. Nilai kolom ini harus cocok dengan nama metode yang diekspor dari kode sumber. |