Skip to main content
POST
Criar endpoint de webhook
Requer o header account com o código da conta. O endpoint criado começa com status Ativo e receberá notificações POST para cada evento listado em events.
O campo events deve conter ao menos um evento válido. Consulte a referência de eventos para ver todos os valores aceitos.

Authorizations

Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Body

application/json
url
string<uri>
required

URL que receberá as notificações via POST

Example:

"https://meusite.com.br/webhook"

events
enum<string>[]
required

Lista de eventos a monitorar. Valores aceitos: welcome, email.confirmation, email.recovery, account.bank.update, account.team.invite, order.paid, order.failed, order.refunded, order.challenged, order.unprocessed, order.chargeback, pix.generated, charge.created, charge.pending, charge.paid, charge.failed, charge.reproved, charge.refunded, charge.partial_refunded, charge.expired, charge.canceled, charge.challenged, charge.chargeback, withdrawal.requested, purchase.many_failed, subscription.canceled, subscription.delayed, subscription.regularized, invoice.created, invoice.paid, invoice.failed

Minimum array length: 1
Available options:
welcome,
email.confirmation,
email.recovery,
account.bank.update,
account.team.invite,
order.paid,
order.failed,
order.refunded,
order.challenged,
order.unprocessed,
order.chargeback,
pix.generated,
charge.created,
charge.pending,
charge.paid,
charge.failed,
charge.reproved,
charge.refunded,
charge.partial_refunded,
charge.expired,
charge.canceled,
charge.challenged,
charge.chargeback,
withdrawal.requested,
purchase.many_failed,
subscription.canceled,
subscription.delayed,
subscription.regularized,
invoice.created,
invoice.paid,
invoice.failed
Example:

Response

Webhook criado com sucesso

mensagem
string
Example:

"Operação realizada com sucesso"

erro
boolean
Example:

false

mensagenserro
string[]
Example:
codigoretorno
integer
Example:

200

id
string
Example:

"00000000-0000-0000-0000-000000000000"

data
any | null

Dados retornados pela operação (objeto, array ou vazio)