Webhooks

Criar Webhook

Webhooks são configurados por conta, não por empresa. Uma única configuração recebe eventos de todas as empresas da conta. Para identificar qual empresa gerou o evento, utilize o objeto company presente no payload.

Eventos disponíveis:

EventoDescrição
invoice.status_changedQualquer alteração de status — criação, autorização, rejeição, cancelamento etc.
invoice.authorizedNota fiscal autorizada
invoice.rejectedNota fiscal rejeitada
invoice.canceledNota fiscal cancelada

O evento invoice.status_changed cobre todo o ciclo de vida da nota e é suficiente para a maioria das integrações.

post/v1/webhooks

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/webhooks
  • Auth: API key in header X-Api-Key

Request body

idstring uuid
eventstring 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.

urlstring required

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

Response

OK

idstring uuid
eventstring nullable

Evento configurado

urlstring nullable

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

enabledboolean

Indica se o webhook está ativo

Changes

No recorded changes to this operation across all 1 revision of this API.