Webhooks

Oversigt over webhooks

Sådan leverer ThunderPhone hændelser i realtid, sådan verificerer du signaturer, og sådan sammenlignes de ældre og endpoint-baserede leveringsmodeller.

ThunderPhone sender HTTP-POST-anmodninger til din server, når der sker noget under et opkald — et indgående opkald starter, et opkald slutter, en evalueringskørsel fuldføres, en alarm udløses osv. Der er to leveringsmodeller:

Alle ti hændelsestyper i hændelseskataloget leveres via webhookendepunkter. De seks opkaldslivscyklushændelser (telephony.incoming, telephony.complete, telephony.tool, web.incoming, web.complete, web.tool) sendes også til det forældede webhook med enkelt URL — hvis du både har en forældet URL og et matchende endepunkt, modtager du hændelsen på begge ruter. Blokerende adfærd (konfigurationsudvekslingen for telephony.incoming / web.incoming og værktøjsafsendelse i webhooktilstand) findes udelukkende på den forældede rute; hver levering til et endepunkt er en fire-and-forget-notifikation.

Payloadformat#

Leveringer til endepunkter er et JSON-objekt med data, event_id og type:

{
  "data": {
    "call_id": 987654321,
    "from_number": "+14155550199",
    "to_number": "+15551234567"
  },
  "event_id": "3f6b2ad0-1c9e-4a57-9f2b-8f6f0f9d2f11",
  "type": "telephony.incoming"
}

event_id er unik for hver udsendt hændelse. Den er identisk på tværs af genforsøg og på tværs af alle endepunkter, der modtager hændelsen — dedupliker efter den.

Det forældede webhook med enkelt URL sender samme type og data, men uden event_id:

{
  "type": "telephony.incoming",
  "data": { "call_id": 987654321, "from_number": "+14155550199", "to_number": "+15551234567" }
}

Ved overførsel serialiseres alle brødtekster kanonisk — nøgler sorteres alfabetisk, uden mellemrum, UTF-8. De pænt formaterede eksempler i denne dokumentation er kun for læsbarhed.

Se hændelseskataloget for den komplette liste over hændelsestyper og payloadfelter.

Signaturverifikation#

Hver anmodning indeholder en HMAC-SHA256-signatur over den rå anmodnings- brødtekst i headeren X-ThunderPhone-Signature. Signeringsnøglen er endepunktets secret (eller din organisations webhook-secret for ældre leveringer).

Trin#

1. Læs den rå anmodningsbrødtekst før enhver parsing.
2. Beregn hmac_sha256(secret, body).hexdigest().
3. Sammenlign i konstant tid med headeren X-ThunderPhone-Signature.

Vi signerer nøjagtigt de bytes, vi sender, og disse bytes er den kanoniske JSON-serialisering (sorterede nøgler, kompakte separatorer). Derfor virker verifikation mod den rå brødtekst altid — og hvis dit framework kun giver dig parset JSON, producerer en genserialisering med sorterede nøgler og kompakte separatorer identiske bytes. Begge fremgangsmåder er beskrevet i verifikationsvejledningen.

import hmac
import hashlib
 
def verify_signature(body: bytes, signature: str, secret: str) -> bool:
    expected = hmac.new(
        secret.encode("utf-8"),
        body,
        hashlib.sha256,
    ).hexdigest()
    return hmac.compare_digest(expected, signature or "")
 
# Example Flask handler
from flask import Flask, request, abort
app = Flask(__name__)
 
@app.post("/thunderphone-webhook")
def handle():
    body = request.get_data()
    sig = request.headers.get("X-ThunderPhone-Signature", "")
    if not verify_signature(body, sig, WEBHOOK_SECRET):
        abort(401)
    event = request.get_json()
    # dispatch on event["type"] …
    return "", 204

import crypto from "node:crypto";
import express from "express";
 
function verifySignature(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),
  );
}
 
const app = express();
app.post(
  "/thunderphone-webhook",
  express.raw({ type: "application/json" }),
  (req, res) => {
    const sig = req.header("X-ThunderPhone-Signature") || "";
    if (!verifySignature(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);
  },
);

Leveringssemantik#

Denne semantik gælder for leveringer til endepunkter. Den ældre webhook med én URL er ét enkelt synkront forsøg uden genforsøg.

Valg mellem ældre og endepunktbaserede webhooks#

Nye integrationer bør modtage hændelser via endepunktbaserede webhooks. Behold (eller tilføj) kun en ældre URL, hvis du konfigurerer opkald dynamisk ved besvarelse eller bruger værktøjskald i webhook-tilstand — disse anmodnings-/svarudvekslinger kører kun på den ældre sti.

Relateret#