Skip to Content
API-ReferenzWebhooks

Webhooks (Empfang)

Wenn Ereignisse in Ihrem SupDesk-Projekt auftreten, liefern Outbound-Webhooks HTTP-POST-Anfragen an Ihre konfigurierten Endpoints. Diese Seite dokumentiert das Payload-Format, den Signaturmechanismus und das Wiederholungsverhalten, damit Sie zuverlässige Webhook-Empfänger erstellen können.

Payload-Format

Jede Webhook-Zustellung verwendet einen standardisierten Umschlag:

{
  "event": "post.created",
  "timestamp": "2026-07-15T12:00:00.000Z",
  "project_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": { ... }
}
FeldTypBeschreibung
eventstringDas Ereignis, das die Zustellung ausgelöst hat
timestampstringISO-8601-Zeitstempel des Ereignisses
project_idstringUUID des Projekts, in dem das Ereignis aufgetreten ist
dataobjectEreignisspezifischer Payload (siehe unten)

Ereignisse

post.created

Ein neuer Feedback-Beitrag wurde eingereicht.

{
  "event": "post.created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Add dark mode",
    "type": "feature",
    "status": "open",
    "author_type": "end_user",
    "body": "It would be great to have a dark mode option.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

post.updated

Ein Feedback-Beitrag wurde bearbeitet.

{
  "event": "post.updated",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Add dark mode",
    "type": "feature",
    "status": "open",
    "author_type": "end_user",
    "body": "It would be great to have a dark mode option.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

post.deleted

Ein Feedback-Beitrag wurde gelöscht.

{
  "event": "post.deleted",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Add dark mode",
    "type": "feature",
    "status": "open",
    "author_type": "end_user",
    "body": "It would be great to have a dark mode option.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

post.status_changed

Der Status eines Beitrags wurde geändert.

{
  "event": "post.status_changed",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Add dark mode",
    "type": "feature",
    "old_status": "open",
    "new_status": "planned",
    "author_type": "member",
    "body": "We're planning this for Q3.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

comment.created

Ein neuer Kommentar wurde zu einem Beitrag hinzugefügt.

{
  "event": "comment.created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "post_id": "550e8400-e29b-41d4-a716-446655440001",
    "post_title": "Add dark mode",
    "author_type": "end_user",
    "body": "Any update on this?",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

comment.updated

Ein Kommentar wurde bearbeitet.

{
  "event": "comment.updated",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "post_id": "550e8400-e29b-41d4-a716-446655440001",
    "post_title": "Add dark mode",
    "author_type": "end_user",
    "body": "Any update on this?",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

comment.deleted

Ein Kommentar wurde gelöscht.

{
  "event": "comment.deleted",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "post_id": "550e8400-e29b-41d4-a716-446655440001",
    "post_title": "Add dark mode",
    "author_type": "end_user",
    "body": "Any update on this?",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

message.created

Eine neue private Nachricht wurde gesendet.

{
  "event": "message.created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "thread_id": "550e8400-e29b-41d4-a716-446655440001",
    "thread_subject": "Help needed",
    "sender": "end_user",
    "body": "I can't find the settings page.",
    "via": "web",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

message.updated

Eine private Nachricht wurde bearbeitet.

{
  "event": "message.updated",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "thread_id": "550e8400-e29b-41d4-a716-446655440001",
    "thread_subject": "Help needed",
    "sender": "end_user",
    "body": "I can't find the settings page.",
    "via": "web",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

message.deleted

Eine private Nachricht wurde gelöscht.

{
  "event": "message.deleted",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "thread_id": "550e8400-e29b-41d4-a716-446655440001",
    "thread_subject": "Help needed",
    "sender": "end_user",
    "body": "I can't find the settings page.",
    "via": "web",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

beta_feedback.created

Ein Beta-Tester hat Feedback zu einem Beta-Programm eingereicht.

{
  "event": "beta_feedback.created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "program": "Acme 2.0 Beta",
    "category": "bug",
    "severity": "high",
    "title": "Crash on export",
    "body": "The app closes when I export a large file.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

severity kann null sein.

beta_feedback.deleted

Ein Beta-Feedback-Eintrag wurde gelöscht.

{
  "event": "beta_feedback.deleted",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "program": "Acme 2.0 Beta",
    "category": "bug",
    "severity": "high",
    "title": "Crash on export",
    "body": "The app closes when I export a large file.",
    "created_at": "2026-07-15T12:00:00Z"
  }
}

waitlist_signup.created

Ein Besucher ist der Warteliste beigetreten.

{
  "event": "waitlist_signup.created",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "jamie@example.com",
    "status": "waiting",
    "position": 42,
    "referral_count": 0,
    "referral_code": "a1b2c3",
    "source": "portal",
    "created_at": "2026-07-15T12:00:00Z",
    "invited_at": null,
    "joined_at": null
  }
}

position ist null für invited- und joined-Einträge.

waitlist_signup.invited

Ein Wartelisten-Eintrag wurde von der Liste eingeladen.

{
  "event": "waitlist_signup.invited",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "jamie@example.com",
    "status": "invited",
    "position": null,
    "referral_count": 0,
    "referral_code": "a1b2c3",
    "source": "portal",
    "created_at": "2026-07-15T12:00:00Z",
    "invited_at": "2026-07-15T12:00:00Z",
    "joined_at": null
  }
}

waitlist_signup.joined

Ein eingeladener Eintrag hat angenommen und ist beigetreten.

{
  "event": "waitlist_signup.joined",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "jamie@example.com",
    "status": "joined",
    "position": null,
    "referral_count": 0,
    "referral_code": "a1b2c3",
    "source": "portal",
    "created_at": "2026-07-15T12:00:00Z",
    "invited_at": "2026-07-15T12:00:00Z",
    "joined_at": "2026-07-15T12:05:00Z"
  }
}

Signaturüberprüfung

Jede Zustellung enthält einen X-SupDesk-Signature-Header:

X-SupDesk-Signature: sha256=a1b2c3d4e5f6...

Der Wert nach sha256= ist die hex-kodierte HMAC-SHA256 des Rohdaten-Request-Bodys, berechnet mit dem Signaturschlüssel Ihres Webhooks.

Überprüfungsschritte

  1. Lesen Sie den Rohdaten-Request-Body (parsen Sie nicht zuerst JSON)
  2. Berechnen Sie HMAC-SHA256(signaturschlüssel, rohdaten_body)
  3. Vergleichen Sie den Hex-Digest mit dem Wert im Signatur-Header
  4. Verwenden Sie einen Vergleich mit konstanter Zeit, um Timing-Angriffe zu verhindern

Node.js-Beispiel

import { createHmac, timingSafeEqual } from "crypto";
 
function verifySupDeskWebhook(secret, rawBody, signatureHeader) {
  const expected = createHmac("sha256", secret)
    .update(rawBody)
    .digest("hex");
  const received = signatureHeader.replace("sha256=", "");
  return timingSafeEqual(Buffer.from(expected), Buffer.from(received));
}
 
// Express example
app.post("/webhooks/supdesk", express.raw({ type: "application/json" }), (req, res) => {
  const sig = req.headers["x-supdesk-signature"];
  if (!verifySupDeskWebhook(SECRET, req.body, sig)) {
    return res.status(401).json({ error: "Invalid signature" });
  }
  const event = JSON.parse(req.body);
  // Process event...
  res.status(200).json({ ok: true });
});

Python-Beispiel

import hmac
import hashlib
from flask import Flask, request, jsonify
 
app = Flask(__name__)
WEBHOOK_SECRET = "your-signing-secret"
 
def verify_signature(secret: str, body: bytes, header: str) -> bool:
    expected = hmac.new(secret.encode(), body, hashlib.sha256).hexdigest()
    received = header.removeprefix("sha256=")
    return hmac.compare_digest(expected, received)
 
@app.route("/webhooks/supdesk", methods=["POST"])
def handle_webhook():
    sig = request.headers.get("X-SupDesk-Signature", "")
    if not verify_signature(WEBHOOK_SECRET, request.data, sig):
        return jsonify(error="Invalid signature"), 401
    event = request.get_json()
    # Process event...
    return jsonify(ok=True), 200

Ruby-Beispiel

require "openssl"
require "sinatra"
require "json"
 
WEBHOOK_SECRET = "your-signing-secret"
 
def verify_signature(secret, body, header)
  expected = OpenSSL::HMAC.hexdigest("SHA256", secret, body)
  received = header.sub("sha256=", "")
  Rack::Utils.secure_compare(expected, received)
end
 
post "/webhooks/supdesk" do
  body = request.body.read
  sig = request.env["HTTP_X_SUPDESK_SIGNATURE"] || ""
  unless verify_signature(WEBHOOK_SECRET, body, sig)
    halt 401, { error: "Invalid signature" }.to_json
  end
  event = JSON.parse(body)
  # Process event...
  status 200
  { ok: true }.to_json
end

Wiederholungen

Wenn eine Webhook-Zustellung fehlschlägt, wiederholt SupDesk mit exponentiellem Backoff:

VersuchVerzögerung
1Sofort
21 Sekunde
32 Sekunden

Wiederholte Bedingungen: 5xx-Antworten, Netzwerkfehler, Timeouts (10 Sekunden).

Nicht wiederholt: 4xx-Antworten (Client-Fehler deuten auf ein Konfigurationsproblem hin).

Auf Webhooks antworten

  • Geben Sie einen 2xx-Statuscode zurück, um den Empfang zu bestätigen
  • Antworten Sie innerhalb von 10 Sekunden, um Timeout-Wiederholungen zu vermeiden
  • Verarbeiten Sie das Ereignis asynchron, wenn Ihre Logik länger dauert
  • Geben Sie bei doppelten Zustellungen dieselbe Antwort zurück (Idempotenz)
Last updated on
BetaFehler