Add or Update a Webhook

This endpoint allows a company to add or update a webhook. Webhooks enable the company to receive data when specific events occur. Each company can have one webhook per webhook type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the company that owns the webhooks.

Body Params

The request body containing the webhook details to add or update.

uri
required

The URL to which event notifications will be sent. Must be a valid HTTPS URL.

webhookType
array
required

Indicates the types of events being subscribed the webhook listens to.

webhookType*
Allowed:
string
required

The authentication token used to validate the webhook.

string

The type of authentication token used for the webhook (e.g., bearer, x-api-key).

boolean

Indicates whether the webhook should fire when the specified event is received.

Responses

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