Webhooks
Create webhook endpoint
Create a new webhook endpoint.
POST
/
v1
/
webhooks
/
endpoints
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
description
string
Webhook endpoint description.
url
string
requiredWebhook endpoint URL.
secret
string
Webhook endpoint verification secret (base64 encoded random bytes). If not defined, a secret is automatically generated and only accessible in the UI.
rate_limit
number
Webhook rate limit (per second).
event_types
enum<string>[]
Webhook event types filter. If not defined, all event messages will be sent.
Available options:
customer.created
, customer.updated
, customer.archived
, customer.recovered
, customer.deleted
, subscription.created
, subscription.trial_ended
, subscription.activated
, subscription.paused
, subscription.updated
, subscription.cancellation_scheduled
, subscription.cancelled
, subscription.voided
, subscription.errored
, subscription.charged
, subscription.commitment_renewed
, invoice.created
, invoice.grace_period.started
, invoice.ready
, invoice.settled
, invoice.errored
, invoice.reminder_sent
, credit_note.ready
, credit_note.settled
, checkout.created
, checkout.completed
, payment_method.created
, payment_method.activated
, payment_method.errored
, payment_method.deleted
, wallet.credited
, wallet.debited
, daily_analytics.ready
, dataloader.failed
, credit.low_balance
, credit.balance_refreshed
, credit.created
, credit.updated
, credit.balance_at_zero
, credit.topup_transaction_created
, credit.usage_transaction_created
, quote.created
, quote.updated
, quote.approved
, quote.sent
, quote.viewed
, quote.signed
, quote.voided
, bank_account.created
, bank_account.deleted
, custom_property.created
, custom_property.updated
, custom_property.deleted
, custom_property.value_created
, custom_property.value_updated
Response
201 - application/json
id
string
requiredWebhook endpoint ID.
description
string
requiredWebhook endpoint description.
url
string
requiredWebhook endpoint URL.
rate_limit
number | null
requiredWebhook rate limit (per second).
event_types
enum<string>[] | null
requiredWebhook event types filter. If not defined, all event messages will be sent.
Available options:
customer.created
, customer.updated
, customer.archived
, customer.recovered
, customer.deleted
, subscription.created
, subscription.trial_ended
, subscription.activated
, subscription.paused
, subscription.updated
, subscription.cancellation_scheduled
, subscription.cancelled
, subscription.voided
, subscription.errored
, subscription.charged
, subscription.commitment_renewed
, invoice.created
, invoice.grace_period.started
, invoice.ready
, invoice.settled
, invoice.errored
, invoice.reminder_sent
, credit_note.ready
, credit_note.settled
, checkout.created
, checkout.completed
, payment_method.created
, payment_method.activated
, payment_method.errored
, payment_method.deleted
, wallet.credited
, wallet.debited
, daily_analytics.ready
, dataloader.failed
, credit.low_balance
, credit.balance_refreshed
, credit.created
, credit.updated
, credit.balance_at_zero
, credit.topup_transaction_created
, credit.usage_transaction_created
, quote.created
, quote.updated
, quote.approved
, quote.sent
, quote.viewed
, quote.signed
, quote.voided
, bank_account.created
, bank_account.deleted
, custom_property.created
, custom_property.updated
, custom_property.deleted
, custom_property.value_created
, custom_property.value_updated
created_at
string
requiredWebhook creation date.
Was this page helpful?