POST
/webhooksCreate Webhook
This endpoint is used to create a webhook.
POST
/webhooksImportant Notes
Validation Rules:
- If authType is none, then userName, password, and token must not be present.
- If authType is basic, both userName and password are mandatory.
- If authType is querystring or authheader or header or bearer token must be provided.
- You must provide either user credentials or a token, but not both.
Example Request:
{
"endpoint": "https://example.com/updated-hook",
"authType": "querystring",
"token": "new-token-1234"
}Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
» isAlertHook | body | boolean | Optional | Indicates if this webhook is used for alerts. |
» endpoint | body | string | Required | Target URL where the webhook will send HTTP POST requests. |
» authType | body | string | Required | Authentication method to use (none, basic, querystring, authheader, header, bearer) |
» userName | body | string | Optional | Required when authType is basic. Ignored if authType is none. |
» password | body | string | Optional | Required when authType is basic. Ignored if authType is none. |
» token | body | string | Optional | Required when authType is any token-based type (querystring, authheader, header, bearer). |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Webhook created successfully. | |
| 400 | Bad Request | Bad Request – Validation failed or incorrect parameters. | None |
| 401 | Unauthorized | Unauthorized – Authentication credentials are invalid or missing. | None |
| 429 | Too Many Requests | Too Many Requests – Rate limiting in effect. | None |
| 500 | Internal Server Error | Internal Server Error – An unexpected issue occurred on the server. | None |
Example Request
# You can also use wget
curl -X POST /webhooks/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{"isAlertHook":"string","endpoint":"string","authType":"string","userName":"string","password":"string","token":"string"}'
Body parameter
{
"isAlertHook": true,
"endpoint": "https://example.com/webhook",
"authType": "none",
"userName": "admin",
"password": "securepassword123",
"token": ""
}
Example responses
201 Response
{
"message": "Webhook created successfully"
}
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.