Create a new webhook.
POST
/webhooks
201Description
If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.
Request Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
Name | Required | string | --- | --- | --- | |
Description | string | --- | 2000 characters | --- | ||
Url | string | --- | --- | --- | ||
HashKey | string | --- | 50 characters | --- | ||
ElevatedRoles | array | --- | --- | --- | ||
ConfigData | object | --- | --- | --- | ||
BeforeProcessRequest | boolean | --- | --- | --- | ||
ApiClientIDs | array | --- | --- | --- | ||
WebhookRoutes | array | --- | --- | --- | ||
DeliveryConfigID | string | --- | --- | --- |
Response Body
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
ID | string | --- | 100 characters | --- | ||
Name | string | --- | --- | --- | ||
Description | string | --- | 2000 characters | --- | ||
Url | string | --- | --- | --- | ||
HashKey | string | --- | 50 characters | --- | ||
ElevatedRoles | array | --- | --- | --- | ||
ConfigData | object | --- | --- | --- | ||
BeforeProcessRequest | boolean | --- | --- | --- | ||
ApiClientIDs | array | --- | --- | --- | ||
WebhookRoutes | array | --- | --- | --- | ||
DeliveryConfigID | string | --- | --- | --- |