Logo
Try our API
POST/webhooks

Create Webhook

Create webhook

Implementation Notes

This endpoint is used to create a webhook.

Parameters:

  • endpoint: Target URL where the webhook will send HTTP POST requests.
  • authType: Authentication method to use (none, basic, querystring, authheader, header, bearer).
  • userName: Required when authType is basic. Ignored if authType is none.
  • password: Required when authType is basic. Ignored if authType is none.
  • token: Required when authType is any token-based type (querystring, authheader, header, bearer). Ignored if authType is none.

Important Notes:

  • If authType is none, then userName, password, and token must not be provided.
  • 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 (userName/password) or a token, but not both.

Example Request:



{
"isAlertHook": true,
"endpoint": "https://example.com/webhook",
"authType": "bearer",
"token": "********"
}

POST/webhooks

Parameter Details

NameInTypeRequiredDescription
bodybodyobjectRequirednone
» isAlertHookbodybooleanOptionalIndicates if this webhook is used for alerts.
» endpointbodystringRequiredURL that will receive the webhook payloads.
» authTypebodystringRequiredAuthentication method to use for the webhook.
» userNamebodystringOptionalRequired if authType is basic.
» passwordbodystringOptionalRequired if authType is basic.
» tokenbodystringOptionalRequired if using token-based authType (querystring, authheader, header, bearer).

Responses

StatusMeaningDescriptionSchema
201CreatedWebhook created successfully.
400Bad RequestBad Request – Validation failed or incorrect parameters.None
401UnauthorizedUnauthorized – Authentication credentials are invalid or missing.None
429Too Many RequestsToo Many Requests – Rate limiting in effect.None
500Internal Server ErrorInternal 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}'

Example responses

201 Response
{
"isAlertHook": true,
"endpoint": "https://example.com/webhook",
"authType": "bearer",
"token": "********"
}

Body parameter

{
  "isAlertHook": true,
  "endpoint": "https://example.com/webhook",
  "authType": "none",
  "userName": "admin",
  "password": "securepassword123",
  "token": "********"
}

Example responses

201 Response
{
  "message": "Webhook created successfully"
}
PreviousGet Pricing Data
NextGet Webhook

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.

Contact Support