Skip to main content
POST
Criar Webhook

Authorizations

X-Api-Key
string
header
required

Authorization By X-Api-Key inside request's header

Body

event
string
required

Evento que irá disparar o webhook. Valores aceitos: invoice.status_changed, invoice.authorized, invoice.rejected, invoice.canceled. O evento invoice.status_changed cobre qualquer alteração de status da nota e é suficiente para a maioria dos casos.

Maximum string length: 80
url
string
required

URL que receberá o HTTP POST com o payload do evento

Maximum string length: 200
id
string<uuid>

Response

OK

id
string<uuid>
event
string | null

Evento configurado

url
string | null

URL que receberá o HTTP POST com o payload do evento

enabled
boolean

Indica se o webhook está ativo