Registrar un Endpoint de Webhook para Entrega de Eventos
Register a new webhook endpoint to receive event deliveries for the specified subscribed events.
* para todo, o un comodín de recurso como customer.*. Un endpoint nuevo queda enabled de inmediato y comienza a recibir los eventos que coincidan.
Cada aplicación puede tener como máximo seis endpoints activos, contando los estados enabled, disabled y errored. Excederlo devuelve 409. No existe una operación de actualización, así que cambiar una URL o una suscripción implica crear un reemplazo y eliminar el endpoint anterior — consulta gestión de endpoints para la secuencia sin interrupciones.Autorizaciones
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cuerpo
API version date string provided by the client.
"2026-04-01"
List of event types this endpoint should receive.
1The HTTPS URL to deliver webhook events to.
2048"https://example.com/webhooks/sphere"
Human-readable description of this webhook endpoint.
500"Production payment events handler"
Arbitrary key-value metadata to attach to this endpoint.
Respuesta
The created webhook endpoint, including the signing secret. The secret is returned only here and cannot be retrieved again.
Signing secret for this endpoint. Returned only on creation and never retrievable afterwards.
"whsec_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
enabled, errored, disabled, deleted *, customer.*, transfer.*, document.*, service.*, customer.created, customer.pending, customer.approved, customer.rejected, transfer.created, transfer.pendingFunding, transfer.pendingReview, transfer.fundsReceived, transfer.processing, transfer.succeeded, transfer.returned, transfer.pendingRefundInformation, transfer.failed, transfer.canceled, transfer.refunded, transfer.unexpectedError, transfer.failedPrecondition, transfer.expired, transfer.unfunded, document.pending, document.processing, document.verified, document.rejected, service.pending, service.processing, service.succeeded, service.failed, service.cancelled