Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required
event
enum<string>
Available options:
campaign.created,
campaign.updated,
ticket.created,
transaction.succeeded,
contact.created,
plan.canceled,
plan.created,
plan.failed,
plan.paused,
plan.resumed,
plan.updated,
refund.created
events
enum<string>[]
Available options:
campaign.created,
campaign.updated,
ticket.created,
transaction.succeeded,
contact.created,
plan.canceled,
plan.created,
plan.failed,
plan.paused,
plan.resumed,
plan.updated,
refund.created
name
string | null
Maximum string length: 255
enabled
boolean

Response

WebhookResource

id
string
required
name
string | null
required
events
any[]
required
enabled
boolean
required
url
string
required
last_status
string
required
last_status_description
string
required
last_used_at
string
required
created_at
string
required
updated_at
string
required
signature
string | null