Skip to main content
Get a Webhook Endpoint V2
Use este endpoint para recuperar um único endpoint de webhook pelo seu ID. A resposta traz a URL do endpoint, seus eventos assinados, sua apiVersion e seu estado atual. O secret de assinatura não faz parte da resposta. Ele é retornado apenas quando o endpoint é criado, portanto, se você não o tiver mais, exclua o endpoint e registre um substituto para obter um novo.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

id
string
obrigatório

Resposta

The requested webhook endpoint.

apiVersion
string | null
obrigatório

API version date string this endpoint was configured with, or null if not set.

Exemplo:

"2026-04-01"

createdAt
string
obrigatório

ISO 8601 timestamp when the endpoint was created.

Exemplo:

"2026-01-01T00:00:00.000Z"

description
string | null
obrigatório

Human-readable description of this webhook endpoint, or null if not set.

Exemplo:

"Production payment events handler"

id
string
obrigatório

The unique identifier of the webhook endpoint.

Exemplo:

"webhook_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

metadata
any | null
obrigatório

Arbitrary key-value metadata attached to this endpoint, or null if not set.

Exemplo:
status
enum<string>
obrigatório

The current state of this endpoint.

Opções disponíveis:
enabled,
errored,
disabled,
deleted
Exemplo:

"enabled"

subscribedEvents
enum<string>[]
obrigatório

List of event types this endpoint receives.

Opções disponíveis:
*,
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
Exemplo:
updatedAt
string
obrigatório

ISO 8601 timestamp when the endpoint was last updated.

Exemplo:

"2026-01-01T00:00:00.000Z"

url
string
obrigatório

The HTTPS URL events are delivered to.

Exemplo:

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

Última modificação em 27 de agosto de 2026