Sign in
Webhooks

Create Webhook

Creates a webhook endpoint that receives event notifications via HTTP POST.

post/webhooks

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

api_version'v1' | 'v2' | 'v5'

The API version for this webhook. Defaults to v2.

child_resource_eventsboolean

Whether or not to send events for child resources. For example, if the webhook is created for a company, enabling this will only send events from the company's sub-merchants (child companies).

enabledboolean

Whether or not the webhook is enabled. Defaults to true.

eventsstring[]

The events to send the webhook for, in dot form (for example payment.succeeded).

resource_idstring nullable

The company or app to create the webhook for. Defaults to the current company.

urlstring required

The URL to send the webhook to.

Response

webhook created

api_version'v1' | 'v2' | 'v5' required

The API version used to format payloads sent to this webhook endpoint.

child_resource_eventsboolean required

Whether events are sent for child resources. For example, if the webhook is on a company, enabling this sends events only from the company's sub-merchants (child companies).

created_atstring required

When the webhook was created, as an ISO 8601 timestamp.

enabledboolean required

Whether this webhook endpoint is currently active and receiving events.

eventsstring[] required
idstring required

Webhook ID, prefixed hook_.

resource_idstring required

ID of the resource (company or app) this webhook is attached to.

testable_eventsstring[] required
urlstring required

Destination URL where webhook payloads are delivered via HTTP POST.

webhook_secretstring nullable required

Secret key used to sign webhook payloads for verification. Include this in your HMAC validation logic. Returned on the create response and to interactive dashboard sessions; null for API-key and OAuth callers on later reads.

Example response

{
  "api_version": "v1"
}

Changes