Webhooks

Alterar Webhook

put/v1/webhooks/{id}

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/{id}
  • Auth: API key in header X-Api-Key

Path parameters

idstring uuid required

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

Success

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

Changes

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