Sign in

v1

latestOpenAPI 3.0.12026-07-24373659.1 KB
Webhooks

Criar Webhook

post/api/v1/webhooks

Request body

namestring

Nome do Webhook

urlstring

URL de destino dos eventos

emailstring

E-mail que receberão notificações sobre o Webhook

enabledboolean

Define se o Webhook está ativo

interruptedboolean

Define se a fila de sincronização está interrompida

eventsstring[]

Lista de eventos enviados pelo Webhook

sendType'NON_SEQUENTIALLY' | 'SEQUENTIALLY'

Sequencial (SEQUENTIALLY) ou não sequencial (NON_SEQUENTIALLY)

authTokenstring

Token de autenticação do Webhook

Example request

{
  "name": "INPUT",
  "url": "https://www.exemplo.com/webhook/asaas",
  "email": "john.doe@asaas.com.br",
  "enabled": true,
  "events": [
    "[INVOICE_NFE_CREATED, PRODUCTS_STOCK_INPUT]"
  ],
  "sendType": "SEQUENTIALLY",
  "authToken": "5tLxsL6uoN"
}

Response

OK

namestring

Nome do Webhook

urlstring

URL de destino dos eventos

emailstring

E-mail que receberão notificações sobre o Webhook

enabledboolean

Define se o Webhook está ativo

interruptedboolean

Define se a fila de sincronização está interrompida

eventsstring[]

Lista de eventos enviados pelo Webhook

sendType'NON_SEQUENTIALLY' | 'SEQUENTIALLY'

Sequencial (SEQUENTIALLY) ou não sequencial (NON_SEQUENTIALLY)

idstring

Identificador único do webhook

hasAuthTokenboolean

Define se há token de autenticação do Webhook

Example response

{
  "name": "INPUT",
  "url": "https://www.exemplo.com/webhook/asaas",
  "email": "john.doe@asaas.com.br",
  "enabled": true,
  "events": [
    "[INVOICE_NFE_CREATED, PRODUCTS_STOCK_INPUT]"
  ],
  "sendType": "SEQUENTIALLY",
  "id": "e8314cb8-5daa-41da-9d7f-5d68b67835e9",
  "hasAuthToken": true
}