Webhook

متادیتا برای انواع مختلف وب هوک. اگر inlineCloudFunction استفاده می‌کنید، کد منبع شما باید در فهرستی با همان نام مقدار کلید executeFunction باشد. برای مثال، مقدار my_webhook برای کلید executeFunction ساختار کدی مانند این دارد: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json

نمایندگی 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.
زمینه های
handlers[]

object ( Handler )

لیست کنترل کننده های این وب هوک.

فیلد اتحادیه webhook_type . فقط یک نوع وب هوک پشتیبانی می شود. webhook_type فقط می تواند یکی از موارد زیر باشد:
httpsEndpoint

object ( HttpsEndpoint )

نقطه پایانی HTTPS وب هوک سفارشی.

inlineCloudFunction

object ( InlineCloudFunction )

فراداده برای عملکرد ابری که از کد موجود در پوشه webhooks مستقر شده است.

گرداننده

نام کنترل کننده webhoook را اعلام می کند. یک وب هوک می تواند چندین کنترل کننده ثبت شده داشته باشد. این کنترل کننده ها را می توان از چندین مکان در پروژه Actions شما فراخوانی کرد.

نمایندگی YAML
name: string
زمینه های
name

string

ضروری. نام کنترل کننده باید در بین همه کنترل‌کننده‌های پروژه Actions منحصربه‌فرد باشد. می توانید نام این کنترل کننده را بررسی کنید تا عملکرد صحیح را در کد منبع تکمیل خود فراخوانی کنید.

HttpsEndpoint

REST نقطه پایانی برای اطلاع در صورتی که از ویرایشگر درون خطی استفاده نمی کنید.

نمایندگی YAML
baseUrl: string
httpHeaders: 
  string: string
endpointApiVersion: integer
زمینه های
baseUrl

string

نشانی وب پایه HTTPS برای نقطه پایانی شما (HTTP پشتیبانی نمی‌شود). نام‌های Handler پس از دو نقطه به مسیر URL اصلی اضافه می‌شوند (با دنبال کردن راهنمای سبک در https://cloud.google.com/apis/design/custom_methods) . به عنوان مثال، یک URL پایه "https://gactions.service.com/api" درخواست هایی با URL "https://gactions.service.com/api:{method}" دریافت می کند.

httpHeaders

map (key: string, value: string)

نقشه پارامترهای HTTP در درخواست POST گنجانده شود.

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

endpointApiVersion

integer

نسخه پروتکل مورد استفاده توسط نقطه پایانی. این پروتکلی است که توسط همه انواع انجام به اشتراک گذاشته شده است و مختص نوع انجام Google نیست.

InlineCloudFunction

ابرداده یک تابع Cloud درون خطی را که از پوشه webhooks مستقر شده نگه می دارد.

نمایندگی YAML
executeFunction: string
زمینه های
executeFunction

string

نام نقطه ورودی Cloud Function. مقدار این فیلد باید با نام روش صادر شده از کد منبع مطابقت داشته باشد.