/webhooks
Create webhook allows you to add a webhook that will receive events to the platform.
There are four authentication options for webhooks; none, basic authentication (username and password), bearer token and API keys.
| Attribute | Description | Data type | Required |
|---|---|---|---|
| url | Receiving URL address | string | Yes | Not set |
| authentication | A valid authetication type. See Authentication types below. | string | Yes |
| username | Your basic auth username. | string | If the basic_auth authentication type is requested. |
| password | Your basic auth password. | string | If the basic_auth authentication type is requested. |
| token | Your bearer token. | string | If the bearer_token authentication type is requested. |
| key | Your api key. | string | If the api_key authentication type is requested. |
| value | Your api value. | string | If the api_key authentication type is requested. |
No authentication is required for the receiving URL. Simple pass none in the authentication parameter.
Username and password is required for the receiving URL. Simple pass basic_auth in the authentication parameter with the username and password parameters.
Bearer token is required for the receiving URL. Simple pass bearer_token in the authentication parameter with the token parameter.
API key value pairs are required for the receiving URL. Simple pass api_key in the authentication parameter with the key and value parameters.
{
"url":"http://test.com",
"authentication":"none"
}
{
"result": "success",
"status": 200,
"data": {
"id": 189,
"created_at": "2025-04-29T08:48:04Z",
"updated_at": "2025-04-29T08:48:04Z",
"url": "http://test.com",
"authentication": "none"
}
}
| Code | Status | Description |
|---|---|---|
| too_many_webhooks | 422 | Max webhooks created |
Sign up to our newsletter to keep up-to-date.