Skip to main content
Create a Webhook Endpoint V2
Usa este endpoint para registrar una URL a la que SpherePay entrega eventos, junto con la lista de eventos que debe recibir. Suscríbete con nombres de eventos exactos del catálogo de eventos, o con un comodín — * 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.
El secreto de firma (con prefijo whsec_) se devuelve exactamente una vez, en esta respuesta. Ningún GET lo devuelve y no se puede recuperar después. Guárdalo de forma segura — lo necesitas para verificar la firma en cada entrega.
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

Authorization
string
header
requerido

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

Cuerpo

application/json
apiVersion
string
requerido

API version date string provided by the client.

Ejemplo:

"2026-04-01"

subscribedEvents
string[]
requerido

List of event types this endpoint should receive.

Minimum array length: 1
Ejemplo:
url
string<uri>
requerido

The HTTPS URL to deliver webhook events to.

Maximum string length: 2048
Ejemplo:

"https://example.com/webhooks/sphere"

description
string

Human-readable description of this webhook endpoint.

Maximum string length: 500
Ejemplo:

"Production payment events handler"

metadata
object

Arbitrary key-value metadata to attach to this endpoint.

Ejemplo:

Respuesta

The created webhook endpoint, including the signing secret. The secret is returned only here and cannot be retrieved again.

apiVersion
string | null
requerido
createdAt
string
requerido
description
string | null
requerido
id
string
requerido
metadata
unknown
requerido
secret
string
requerido

Signing secret for this endpoint. Returned only on creation and never retrievable afterwards.

Ejemplo:

"whsec_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

status
enum<string>
requerido
Opciones disponibles:
enabled,
errored,
disabled,
deleted
subscribedEvents
enum<string>[]
requerido
Opciones disponibles:
*,
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
updatedAt
string
requerido
url
string
requerido
Última modificación el 27 de agosto de 2026