Adicionar Custom Header to Webhook Call

[LuizEdgar]

Bem-vindo!

• Sim, pesquisei solicitações semelhantes no GitHub e não encontrei nenhum.

Qual tipo de recurso?

Integração

Qual a motivação para a solicitação?

Não existe uma forma de saber quem está chamando meu Webhook.
Quero adicionar custom Headers ao Webhook para que ele envie um secret ao chamar o Webhook, e então eu possa verificar que a chamada realmente veio do meu Evolution.

Exemplos de Uso

Adicionar uma nova opção para custom Header:
Authorization Bearer abcdefghijklm12345

O secret abcdefghijklm12345 seria enviado em um Header na requisição HTTPS do Webhook.
Eu verifico o abcdefghijklm12345 do meu lado.

Como o recurso deve ser desenvolvido?

No response

Notas Adicionais

No response

[LuizEdgar]

É importante que seja um custom Header porque eu posso escolher o que mandar, por exemplo o Vercel utiliza o header x-vercel-protection-bypass para proteger ambiente de dev. Nesse caso eu poderia utilizar qualquer Header e checar do lado do server que recebe o Webhook.

[jordanrendric]

Também preciso de uma funcionalidade de Header customizado, estou pensando em fazer um fork e implementar isso eu mesmo kkkkk

[jordanrendric]

@LuizEdgar eu descobri que já tem suporte a Headers customizados, apenas configurando pela API. No dash do manager não dá para adicionar, mas já resolve por suportar na api.

Eu documentei a forma de chamar essa api (que era o que faltava) e abri um PR caso o @DavidsonGomes queira adicionar nas docs: EvolutionAPI/docs-evolution#22

De toda forma vou deixar aqui embaixo:

Configurando headers customizados no webhook

Use o endpoint POST /event/webhook/set/{instanceName} com o campo headers:

{
  "webhook": {
    "enabled": true,
    "url": "https://seu-endpoint.com/webhook",
    "headers": {
      "Authorization": "Bearer abcdefghijklm12345"
    },
    "events": [
      "MESSAGES_UPSERT",
      "MESSAGES_UPDATE",
      "CONNECTION_UPDATE",
      "SEND_MESSAGE"
    ],
    "byEvents": false,
    "base64": false
  }
}

Exemplo com curl:

curl -X POST "https://sua-evolution-api.com/event/webhook/set/sua-instancia" \
  -H "Content-Type: application/json" \
  -H "apikey: SUA_API_KEY" \
  -d '{
    "webhook": {
      "enabled": true,
      "url": "https://seu-endpoint.com/webhook",
      "headers": {
        "Authorization": "Bearer abcdefghijklm12345"
      },
      "events": ["MESSAGES_UPSERT", "CONNECTION_UPDATE"],
      "byEvents": false,
      "base64": false
    }
  }'

A partir daí, toda requisição de webhook será enviada com o header Authorization: Bearer abcdefghijklm12345, e você pode validar do seu lado.

Outros formatos suportados

Qualquer header HTTP é aceito:

"headers": {
  "X-Api-Key": "sua-chave-secreta",
  "X-Custom-Secret": "outro-valor"
}

JWT automático

Também existe um recurso especial: se você passar jwt_key, a Evolution gera um JWT (HS256, expira em 10min) automaticamente a cada envio:

"headers": {
  "jwt_key": "sua-chave-secreta-para-assinatura"
}

O header enviado será Authorization: Bearer <jwt_gerado>, renovado a cada evento.