Skip to main content
GET
Ver Webhook da Instância

Autorizações

token
string
header
obrigatório

Resposta

Configuração do webhook retornada com sucesso

url
string<uri>
obrigatório

URL de destino dos eventos

events
enum<string>[]
obrigatório

Tipos de eventos monitorados

Opções disponíveis:
connection,
history,
messages,
messages_update,
call,
contacts,
presence,
groups,
labels,
chats,
chat_labels,
blocks,
leads
id
string<uuid>

ID único gerado automaticamente

instance_id
string

ID da instância associada

enabled
boolean
padrão:false

Webhook ativo/inativo

AddUrlTypesMessages
boolean
padrão:false

Incluir na URLs o tipo de mensagem

addUrlEvents
boolean
padrão:false

Incluir na URL o nome do evento

excludeMessages
enum<string>[]

Filtros para excluir tipos de mensagens

Opções disponíveis:
wasSentByApi,
wasNotSentByApi,
fromMeYes,
fromMeNo,
isGroupYes,
IsGroupNo
created
string<date-time>
read-only

Data de criação (automática)

updated
string<date-time>
read-only

Data da última atualização (automática)