Operations

Verificar assinaturas de webhook

Todo webhook e solicitação de ferramenta enviados pelo ThunderPhone são assinados. Verifique a assinatura uma vez com a receita abaixo e reutilize a mesma verificação em todos os endpoints que você executar.

Todas as solicitações que enviamos ao seu servidor — entregas de webhook e invocações de endpoint de ferramenta — incluem uma assinatura HMAC-SHA256 no cabeçalho X-ThunderPhone-Signature. Faça a verificação corretamente uma vez e use o mesmo auxiliar em todos os manipuladores.

O algoritmo#

1. Leia o corpo bruto da solicitação — os bytes exatos que enviamos por POST para você.
2. Calcule hmac_sha256(secret, body).hexdigest().
3. Compare em tempo constante com X-ThunderPhone-Signature. (Uma comparação ingênua de strings vaza informações de tempo.)

Assinamos exatamente os bytes que transmitimos, portanto verificar o corpo bruto sempre funciona. Esses bytes também são a serialização JSON canônica da carga — chaves ordenadas alfabeticamente, separadores compactos (, e : sem espaços), UTF-8. Isso oferece uma segunda receita, totalmente equivalente, quando seu framework expõe apenas JSON analisado: serialize novamente de forma canônica e aplique HMAC a isso.

# Equivalent to hashing the raw body:
import json
canonical = json.dumps(payload, separators=(",", ":"), sort_keys=True).encode("utf-8")

Prefira o corpo bruto — é uma etapa a menos e evita particularidades de conversão de ida e volta de números JSON em algumas linguagens.

Qual segredo?#

Armazene o segredo no seu gerenciador de segredos ou em uma variável de ambiente — nunca o confirme em um commit.

Implementações de referência#

Todas as quatro verificam o corpo bruto da solicitação:

import hashlib
import hmac
 
 
def verify(body: bytes, signature: str, secret: str) -> bool:
    """Constant-time HMAC-SHA256 verification."""
    expected = hmac.new(
        secret.encode("utf-8"),
        body,
        hashlib.sha256,
    ).hexdigest()
    return hmac.compare_digest(expected, signature or "")

import crypto from "node:crypto";
 
export function verify(body, signature, secret) {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(body)
    .digest("hex");
  if (!signature || expected.length !== signature.length) return false;
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signature),
  );
}

package webhook
 
import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
)
 
func Verify(body []byte, signature, secret string) bool {
    mac := hmac.New(sha256.New, []byte(secret))
    mac.Write(body)
    expected := hex.EncodeToString(mac.Sum(nil))
    return hmac.Equal([]byte(expected), []byte(signature))
}

require "openssl"
 
def verify(body, signature, secret)
  expected = OpenSSL::HMAC.hexdigest("SHA256", secret, body)
  Rack::Utils.secure_compare(expected, signature.to_s)
end

Integração específica do framework#

from fastapi import FastAPI, HTTPException, Request
 
app = FastAPI()
 
@app.post("/thunderphone-webhook")
async def hook(request: Request):
    body = await request.body()           # raw bytes, NOT request.json()
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify(body, sig, SECRET):
        raise HTTPException(status_code=401)
 
    import json
    event = json.loads(body)
    # … dispatch on event["type"] …
    return {"ok": True}

import express from "express";
 
const app = express();
 
app.post(
  "/thunderphone-webhook",
  // IMPORTANT: parse as raw; do NOT use express.json() here.
  express.raw({ type: "application/json" }),
  (req, res) => {
    const sig = req.header("X-ThunderPhone-Signature") || "";
    if (!verify(req.body, sig, process.env.WEBHOOK_SECRET)) {
      return res.sendStatus(401);
    }
    const event = JSON.parse(req.body.toString("utf8"));
    // … dispatch on event.type …
    res.sendStatus(204);
  },
);

import json
 
from django.http import JsonResponse, HttpResponseForbidden
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_POST
 
 
@csrf_exempt
@require_POST
def hook(request):
    body = request.body  # raw bytes
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify(body, sig, SECRET):
        return HttpResponseForbidden("invalid signature")
    event = json.loads(body)
    # … dispatch on event["type"] …
    return JsonResponse({"ok": True})

Verificação de chamadas de ferramentas#

Quando o agente invoca diretamente uma das suas ferramentas de função (a ferramenta tem um endpoint), a solicitação inclui dois cabeçalhos do ThunderPhone além dos seus endpoint.headers configurados:

• X-ThunderPhone-Call-ID — o ID numérico da chamada ativa.
• X-ThunderPhone-Signature — HMAC-SHA256, com chave definida pelo seu segredo de webhook no nível da organização, sobre os bytes exatos do corpo da solicitação.

O mesmo auxiliar verify() funciona sem alterações, com duas particularidades:

1. As ferramentas GET / DELETE não têm corpo. Os argumentos são enviados como parâmetros de consulta, e a assinatura é calculada sobre a string de bytes vazia — ou seja, verify(b"", sig, secret) (Python) ou verify(Buffer.alloc(0), sig, secret) (Node). Não faça hash da string de consulta.
2. Organizações sem um webhook legado configurado não têm um segredo da organização. Nesse caso, as chamadas de ferramentas incluem apenas X-ThunderPhone-Call-ID e nenhum cabeçalho de assinatura. Configure o webhook legado (PUT /v1/webhook) para obter um segredo de assinatura ou autentique as chamadas de ferramentas com seu próprio cabeçalho via endpoint.headers.

@app.post("/tools/search-appointments")
async def tool(request: Request):
    body = await request.body()  # b"" for GET/DELETE tools
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    call_id = request.headers.get("X-ThunderPhone-Call-ID", "")
    if not verify(body, sig, ORG_WEBHOOK_SECRET):
        raise HTTPException(status_code=401)
    args = json.loads(body)
    ...

O despacho de ferramentas no modo webhook (ferramentas sem um endpoint, entregues ao webhook da sua organização como telephony.tool / web.tool) é um webhook assinado comum — a receita padrão acima se aplica. Consulte Ferramentas de função para conhecer os dois formatos de solicitação.

Armadilhas comuns#

Próximas etapas#