Pular para o conteúdo principal
GET
/
webhook
Ver Webhook da Instância
curl --request GET \
  --url https://api.wppfy.com/webhook \
  --header 'token: <api-key>'
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "enabled": true,
    "url": "https://example.com/webhook",
    "events": [
      "messages",
      "messages_update"
    ],
    "excludeMessages": [
      "wasSentByApi",
      "isGroupNo"
    ],
    "addUrlEvents": true,
    "addUrlTypesMessages": true
  },
  {
    "id": "987fcdeb-51k3-09j8-x543-864297539100",
    "enabled": true,
    "url": "https://outro-endpoint.com/webhook",
    "events": [
      "connection",
      "presence"
    ],
    "excludeMessages": [],
    "addUrlEvents": false,
    "addUrlTypesMessages": false
  }
]

Authorizations

​
token
string
header
required

Response

Configuração do webhook retornada com sucesso

​
url
string<uri>
required

URL de destino dos eventos

​
events
enum<string>[]
required

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
default:false

Webhook ativo/inativo

​
AddUrlTypesMessages
boolean
default:false

Incluir na URLs o tipo de mensagem

​
addUrlEvents
boolean
default: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>

Data de criação (automática)

​
updated
string<date-time>

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