Skip to main content
POST
Create an endpoint

Authorizations

x-api-key
string
header
required

Your Store API key (pk_live_...). Create it in Developers › API keys.

x-store-hash
string
header
required

The ID of the store the request is for. Shown in Developers › API keys.

Headers

Idempotency-Key
string

Unique key (for example a UUID) that makes retries safe. The first response is stored for 24 hours and replayed for retries with the same key and body.

Maximum string length: 255

Body

application/json
url
string
required

Public https URL.

events
string[]
required

Event types or ["*"]. See GET /events/types.

description
string
Maximum string length: 255
enabled
boolean
default:true

Response

Created

success
boolean
required
Example:

true

webhook
object
secret
string
Example:

"whsec_Gm2k..."