Pular para o conteúdo principal
GET
Consultar um endpoint de webhook

Autorizações

Authorization
string
header
obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Parâmetros de caminho

endpoint_id
string
obrigatório

Id do endpoint.

Pattern: ^we_[A-Za-z0-9_-]{16}$

Resposta

O endpoint.

id
string

Id do endpoint.

Pattern: ^we_[A-Za-z0-9_-]{16}$
Exemplo:

"we_Xk2v9QeR7tLmN3bA"

object
enum<string>

Sempre webhook_endpoint.

Opções disponíveis:
webhook_endpoint
url
string<uri>

URL que recebe os eventos.

description
string | null

Descrição.

events
enum<string>[]

Eventos assinados. * = todos.

Opções disponíveis:
payment.succeeded,
payment.expired,
payment.failed,
payment.canceled,
payment.refunded,
payment.disputed,
payment.dispute_won,
payment.dispute_lost,
*
status
enum<string>

Estado.

Opções disponíveis:
active,
disabled
created_at
string<date-time>

Criação.