Create a webhook endpoint
POST
/api/v1/admin/webhooks/endpoints
prm_notifications_manage
Registers a URL and the events it should receive. Set all_events to subscribe to everything, present and future, instead of naming keys.
Answers 200, not 201, despite creating a record. Do not gate your client on the status code here.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_notifications_manageManage notification channels & templates - حد المعدل
t_mutate
المعاملات
| المعامل | الوصف |
|---|---|
nameمطلوب
body · string
|
A label for the endpoint. |
urlمطلوب
body · string
|
Where deliveries are POSTed. Validated on save. |
events
body · array
|
Event keys from the catalogue. Ignored when all_events is true. |
all_events
body · boolean
|
Subscribe to every event, including ones added in later releases. |
enabled
body · boolean
|
Defaults to true on create. |
الأخطاء
| الرمز | متى تُرجَع |
|---|---|
ERR_VALIDATION400
|
an unknown event key, or a URL that does not validate |
ERR_CONFLICT409
|
the licensed endpoint ceiling is reached |