Pular para o conteúdo principal
POST
Criar endpoint de webhook

Autorizações

x-api-key
string
header
obrigatório

API Key da organização

Corpo

application/json
url
string<uri>
obrigatório

URL pública que receberá as notificações (POST com corpo JSON).

Maximum string length: 2048
events
enum<string>[]
obrigatório

Eventos que o endpoint vai receber (ao menos um).

Minimum array length: 1

Evento assinado (valor de value em GET /v1/webhook-event-types, ex.: PIX_IN_PAYED).

Opções disponíveis:
PIX_IN_PAYED,
PIX_IN_REFUNDED,
PIX_OUT_ANALYSIS,
PIX_OUT_PAID,
PIX_OUT_REJECTED,
PIX_OUT_ERROR,
PIX_OUT_REFUNDED,
CHECKOUT_PAID,
CHECKOUT_CANCELED,
CHECKOUT_REJECTED,
CHECKOUT_REFUNDED,
INVOICE_INSTALLMENT_PAID,
INVOICE_INSTALLMENT_CHARGE_FAILED,
INVOICE_INSTALLMENT_OVERDUE,
INVOICE_FULLY_PAID,
INFRACTION_OPENED,
INFRACTION_RESOLVED,
BOLETO_CREATED,
BOLETO_PAID,
BOLETO_CANCELED,
BOLETO_REFUNDED
description
string

Descrição livre do endpoint (opcional).

Maximum string length: 255

Resposta

Requisição processada com sucesso

Requisição processada com sucesso

response
object
obrigatório

Dados retornados pela operação; null quando não há conteúdo.

message
string
obrigatório

Mensagem que descreve o resultado.