Criar novo webhook

Cria um novo Webhook na conta Asaas autenticada para enviar notificações dos eventos configurados à URL informada.

Use esta operação para provisionar Webhooks programaticamente. Cada conta pode possuir até 10 Webhooks.

O sendType define o comportamento de entrega: SEQUENTIALLY preserva a ordem dos eventos, enquanto NON_SEQUENTIALLY permite entregas em paralelo sem garantia de ordem.

⚠️

Token de autenticação

Se authToken não for informado, o Asaas gera automaticamente um token seguro. O token gerado é retornado somente na resposta de criação e deve ser armazenado para validar as notificações recebidas.

Conteúdos relacionados

Guides

Body Params

Array com as configurações de Webhooks desejadas

string
required

Nome do Webhook

string
required

URL de destino dos eventos

string
required

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

boolean
required

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

boolean
required

Definir se o Webhook está ativo

string
length between 32 and 255

Token de autenticação do Webhook

events
array of strings
enum
required

Lista de eventos enviados pelo Webhook

events*
string
enum
required

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

Allowed:
int32

Versão da API

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json