Skip to main content
POST
Create Developer Webhook

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
url
string<uri>
required

Public HTTP(S) callback URL.

Maximum string length: 2048
events
enum<string>[]
required
Minimum array length: 1
Available options:
product.created,
product.updated,
product.deleted,
product.delisted,
product.price.changed,
product.inventory.changed,
product.enrichment.started,
product.enrichment.completed,
order.created,
order.updated,
order.deleted,
order.status.changed,
look.created,
look.deleted,
review.created,
review.updated,
review.status.changed,
settlement.created,
settlement.updated,
settlement.status.changed,
return.created,
return.updated,
return.status.changed,
account_statement.created,
account_statement.updated,
account_statement.status.changed,
account_statement.reconciliation.changed,
account_statement.transactions.synced,
account_statement.transactions.failed,
account_statement.sync.queued,
account_statement.sync.started,
account_statement.sync.completed,
account_statement.sync.failed,
account_statement.sync.unavailable
organizationId
string

Optional for API-key requests and otherwise resolved by authentication.

description
string
Maximum string length: 500

Response

Subscription created. The response contains the one-time signing secret.