Skip to main content
POST
Criar webhook

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Corpo

application/json
url
string<uri>
obrigatório

URL HTTPS que recebe as entregas.

events
string[]
obrigatório

Eventos a receber, como payment.confirmed e invoice.finalized.

Exemplo:

Resposta

Endpoint criado, com o segredo de assinatura.

O endpoint recém-criado, com o segredo de assinatura (secret), que aparece só aqui.

id
string<uuid>
url
string<uri>

URL que recebe as entregas.

events
string[]

Eventos assinados. Qualquer evento emitido pode ser assinado pelo nome, inclusive os que ainda não têm payload documentado.

isActive
boolean

Se o endpoint está recebendo entregas.

createdAt
string<date-time>
secret
string