Skip to main content
POST
cURL
Create a new webhook endpoint. The response includes the signing secret which is only returned once.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Cuerpo

application/json
url
string<uri>
requerido
Minimum string length: 1
events
enum<string>[]
requerido
Minimum array length: 1
Opciones disponibles:
subscription.created,
subscription.activated,
subscription.reactivated,
subscription.pause_scheduled,
subscription.pause_updated,
subscription.pause_revoked,
subscription.paused,
subscription.resumed,
subscription.resume_failed,
subscription.canceled,
subscription.updated,
subscription.plan_changed,
subscription.cancellation_scheduled,
subscription.cancellation_revoked,
subscription.plan_change_scheduled,
subscription.plan_change_revoked,
subscription.past_due,
trial.started,
trial.converted,
trial.expired,
trial.will_end,
trial.checkout_ready,
checkout.ready,
payment.received,
payment.failed,
payment.recovered,
payment.retry_failed,
payment.refunded,
payment.disputed,
payment.dispute_resolved,
payment_link.created,
payment_link.completed,
payment_link.failed,
payment_link.canceled,
invoice.created,
invoice.voided,
invoice.overdue,
invoice.upcoming,
payment_method.attached,
payment_method.updated,
customer.created,
customer.updated,
customer.state_changed,
plan_grant.created,
plan_grant.updated,
plan_grant.expired,
plan_grant.revoked,
credits.granted,
credits.purchased,
credits.low,
credits.depleted,
credits.expired,
balance.topped_up,
balance.low,
balance.depleted,
quota.threshold_reached,
quota.exceeded,
seats.updated,
seats.limit_reached,
addon.activated,
addon.deactivated,
usage.recorded,
payout.available,
payout.created,
payout.paid,
payout.failed
description
string
apiVersion
string

Respuesta

Success

id
string
requerido
url
string
requerido
events
string[]
requerido
description
string | null
requerido
isActive
boolean
requerido
apiVersion
string | null
requerido
createdAt
string<date-time>
requerido
secretKey
string
requerido
object
string
requerido
Allowed value: "webhook"
livemode
boolean
requerido