POST/webhook

Create WebHook

This API allows you to configure a webhook endpoint to receive data. The webhook supports different authentication types including basic and token-based.
POST/webhook

Optional Fields

  • userName
  • password
  • token

Implementation Notes

This API allows you to configure a webhook endpoint to receive data. The webhook supports different authentication types including basic and token-based.

Parameter Details

NameInTypeRequiredDescription
bodybodyobjectRequirednone
» endpointbodystring(uri)Requirednone
» authTypebodystringRequirednone
» userNamebodystringOptionalnone
» passwordbodystringOptionalnone
» tokenbodystringOptionalnone

Responses

StatusMeaningDescriptionSchema
200OKWebhook created successfullyInline
400Bad RequestBad RequestNone
401UnauthorizedAuthentication Failed or Account validity ExpiredNone
429Too Many RequestsToo Many RequestsNone
500Internal Server ErrorInternal Server ErrorNone

Example Request

# You can also use wget
curl -X POST /webhook \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "endpoint": "https://sampleendpoint.com/webhook",
  "authType": "basic",
  "userName": "sampleuser",
  "password": "testpassword",
  "token": ""
}

Example responses

200 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.