Add webhook

The method allows creating a webhook to sent event notifications to the specified URL.

Limitations
Method is available for administrator of the account only.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

The method returns the added webhook object. The properties of the object are listed below.

ParameterData typeDescription
idintWebhook ID
created_byintID of the user who created the webhook
created_atintWebhook creation date in the format of Unix Timestamp
updated_atintWebhook edit date in the format of Unix Timestamp
sortintWebhook sorting
disabledboolDefines whether webhook is disabled
destinationstringValid URL where you want to receive a notification
settingsarrayWebhook trigger events
Body Params
RAW_BODY
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json