Webhooks
Create a webhook
POST
/
webhooks
/
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
title
string
requiredArbitrary title of webhook
all_events
boolean
default: falseSpecifies this webhook should trigger on all event types. Either this or events
is required.
public_key
string
PEM-encoded RSA public key for authenticating webhook or callback payloads
events
enum<string>[]
requiredList of events to trigger webhook callbacks for. Either this or all_events
is required.
Available options:
purchase.created
, purchase.paid
, purchase.payment_failure
, purchase.pending_execute
, purchase.pending_charge
, purchase.cancelled
, purchase.hold
, purchase.captured
, purchase.pending_capture
, purchase.released
, purchase.pending_release
, purchase.preauthorized
, purchase.pending_recurring_token_delete
, purchase.recurring_token_deleted
, purchase.subscription_charge_failure
, purchase.pending_refund
, payment.refunded
, billing_template_client.subscription_billing_cancelled
, payout.pending
, payout.failed
, payout.success
callback
string
requiredResponse
201 - application/json
type
string
Object type identifier
id
string
created_on
integer
Object creation time
updated_on
integer
Object last modification time
title
string
requiredArbitrary title of webhook
all_events
boolean
default: falseSpecifies this webhook should trigger on all event types. Either this or events
is required.
public_key
string
PEM-encoded RSA public key for authenticating webhook or callback payloads
events
enum<string>[]
requiredList of events to trigger webhook callbacks for. Either this or all_events
is required.
Available options:
purchase.created
, purchase.paid
, purchase.payment_failure
, purchase.pending_execute
, purchase.pending_charge
, purchase.cancelled
, purchase.hold
, purchase.captured
, purchase.pending_capture
, purchase.released
, purchase.pending_release
, purchase.preauthorized
, purchase.pending_recurring_token_delete
, purchase.recurring_token_deleted
, purchase.subscription_charge_failure
, purchase.pending_refund
, payment.refunded
, billing_template_client.subscription_billing_cancelled
, payout.pending
, payout.failed
, payout.success
callback
string
required