Skip to main content
POST
Create a webhook endpoint

Body

application/json

Parameters for creating a webhook endpoint.

name
string
required

A label you choose to tell this endpoint apart from your others in the dashboard and in list responses. It is never sent to the endpoint.

Example:

"Production events"

url
string<uri>
required

The HTTPS URL we POST each subscribed event to. It must be reachable from the public internet and should return a 2xx quickly, since a slow or non-2xx response is recorded as a failed attempt and retried.

Example:

"https://api.example.com/webhooks/bachs"

event_types
enum<string>[]
required

The event types this endpoint receives. Send at least one; anything not listed is never delivered here, so add a type before you rely on it. Values are matched case-insensitively and stored lowercase.

Minimum array length: 1
Available options:
collection.succeeded,
collection.failed,
collection.underpaid,
checkout.completed,
checkout.expired,
payout.created,
payout.paid,
payout.failed,
refund.created,
refund.paid,
refund.failed,
conversion.completed,
conversion.failed,
customer.created,
customer.updated,
dispute.created,
dispute.updated,
customer.subscription.created,
customer.subscription.updated,
customer.subscription.deleted,
invoice.created,
invoice.paid,
invoice.payment_failed
Example:
event_source
enum<string>

Which account's events reach this endpoint. account: only events that happened on your own account. connect: only events that happened on accounts you own. all: both. Defaults to account when you omit it.

Available options:
account,
connect,
all
Example:

"account"

Response

The created endpoint, including its signing secret.

The created endpoint, plus its signing secret. The secret is returned only once, on creation. Store it securely.

endpoint_id
string
required

Use this identifier to fetch, update, delete, or rotate the secret on this endpoint, and to scope event listings to it.

Example:

"whe_a1e823c073ab743ce5969ceef2db4d42"

name
string
required

The label you gave the endpoint. It is never sent to the endpoint itself.

Example:

"Production events"

url
string<uri>
required

The HTTPS URL we POST each subscribed event to.

Example:

"https://api.example.com/webhooks/bachs"

enabled
boolean
required

When true, matching events are delivered here. A new endpoint is enabled straight away, so have your receiver deployed before you create it.

Example:

true

event_types
enum<string>[]
required

The event types this endpoint now receives, stored lowercase. Anything not listed is never delivered here.

Available options:
collection.succeeded,
collection.failed,
collection.underpaid,
checkout.completed,
checkout.expired,
payout.created,
payout.paid,
payout.failed,
refund.created,
refund.paid,
refund.failed,
conversion.completed,
conversion.failed,
customer.created,
customer.updated,
dispute.created,
dispute.updated,
customer.subscription.created,
customer.subscription.updated,
customer.subscription.deleted,
invoice.created,
invoice.paid,
invoice.payment_failed
Example:
created_at
string
required

When the endpoint was created, as an ISO 8601 timestamp in UTC.

Example:

"2026-03-09T10:00:00.000Z"

updated_at
string
required

When the endpoint was last changed, as an ISO 8601 timestamp in UTC. Rotating the signing secret updates this.

Example:

"2026-03-09T10:00:00.000Z"

signing_secret
string
required

Use this to verify the X-Bachs-Signature header on every delivery to this endpoint and reject anything that does not match. It is shown in full only in this response, so store it in your secret manager now; afterwards you can read it back with GET /v1/webhooks/endpoints/{endpoint_id}/secret (scope webhooks:read) or replace it by rotating.

Example:

"whsec_62da9edb5b97b120f7d55e1e190118b0ec08fcace294dfaf211ec370b6d21f34"

disabled_at
string<date-time> | null

When we turned this endpoint off because its deliveries kept failing, as an ISO 8601 timestamp in UTC. null while the endpoint is enabled, and when you turned it off yourself. See When an endpoint keeps failing.

Example:

"2026-03-12T14:05:00.000Z"

disabled_reason
enum<string> | null

Why we turned this endpoint off. consecutive_failures: every delivery to it failed for at least 72 hours, with no success in between, and we emailed a warning at least 48 hours earlier. null while the endpoint is enabled, and when you turned it off yourself.

Available options:
consecutive_failures,
null
Example:

"consecutive_failures"

event_source
enum<string>

Which account's events reach this endpoint. account: only your own account's events. connect: only the events of accounts you own. all: both.

Available options:
account,
connect,
all
Example:

"account"