Create Webhook

Create a new webhook for the authenticated user's company.

The webhook will receive HTTP POST requests with event data when subscribed events occur.

A unique secret key is automatically generated for signature verification. The secret key is only returned in the response when creating or regenerating the webhook secret, so make sure to store it securely. If you lose the secret key, you can regenerate it using the "Regenerate Webhook Secret" endpoint, but this will invalidate the old secret immediately.

The maximum number of webhooks allowed per company is 50. If you have reached this limit, you will need to delete existing webhooks before creating new ones.

One webhook can be subscribed to multiple events, but each event can only be subscribed to once per webhook. For example, you cannot subscribe to the "review.created" event twice on the same webhook, but you can subscribe to both "review.created" and "review.updated" on the same webhook.

Body Params
string | null

A descriptive name for the webhook. This is optional and helps identify the webhook in the dashboard.

uri
required
length ≤ 2048

The URL where webhook payloads will be delivered. Must be a valid HTTPS URL.

boolean

Whether the webhook should be active immediately after creation.

events
array of strings
required
length ≥ 1

An array of event types to subscribe to. Each event type must be a valid webhook event. Use the /webhooks/events endpoint to get a list of available events.

events*
Responses

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