Webhooks

E-Mail-Zustellungsevents

Erhalten Sie Benachrichtigungen in Echtzeit zum Zustellstatus Ihrer E-Mails. Konfigurieren Sie Ihre Webhook-URL im Dashboard. Alle Events werden aus Sicherheitsgründen mit HMAC-SHA256 signiert.

POSThttps://your-server.com/webhook/email/delivery
!

Prüfen Sie immer die Webhook-Signatur. Erzeugen Sie Ihr Webhook-Secret im Dashboard und prüfen Sie damit eingehende Requests. Berechnen Sie den HMAC über den rohen Request-Body, nicht über neu serialisiertes JSON.

Schnellstart

Ein Listener, der die Signatur prüft und dann das Event verarbeitet. Sobald das Event angenommen ist, antworten Sie mit einem 2xx Statuscode.

const express = require('express');
const crypto = require('crypto');

const app = express();
const WEBHOOK_SECRET = process.env.WEBHOOK_SECRET;

function verifySignature(rawBody, signature) {
  if (!signature) return false;

  const expected = 'sha256=' + crypto
    .createHmac('sha256', WEBHOOK_SECRET)
    .update(rawBody)
    .digest('hex');

  const a = Buffer.from(signature);
  const b = Buffer.from(expected);
  // timingSafeEqual throws when the lengths differ
  return a.length === b.length && crypto.timingSafeEqual(a, b);
}

// express.raw keeps the body as a Buffer, exactly as it was sent
app.post('/webhook/email/delivery', express.raw({ type: 'application/json' }), (req, res) => {
  if (!verifySignature(req.body, req.headers['x-webhook-signature'])) {
    return res.status(401).json({ error: 'Invalid signature' });
  }

  const { event, emailId, data } = JSON.parse(req.body.toString('utf8'));

  console.log('[Email Delivery] ' + event + ' - ' + emailId);

  if (event === 'delivered') {
    console.log('   Recipient: ' + data.recipientEmail);
  } else if (event === 'bounced') {
    console.log('   Reason: ' + data.reason);
  }

  res.status(200).json({ received: true });
});

app.listen(3001, () => {
  console.log('Email delivery webhook listener on port 3001');
  console.log('   POST /webhook/email/delivery');
});

Header

  • X-Webhook-Signaturestringerforderlich

    HMAC-SHA256-Signatur des Request-Bodys. Format: sha256=hex_digest

Testen mit ngrok

Machen Sie Ihren lokalen Listener im Internet erreichbar und hinterlegen Sie die erzeugte URL im Dashboard als Webhook-URL.

ngrok http 3001
# Your webhook URL:
# https://abc123.ngrok.io/webhook/email/delivery

Events

Jedes Event ist ein JSON-Objekt mit event, timestamp und einem data-Objekt. Öffnen Sie ein Event, um den vollständigen Payload und alle Felder zu sehen.

Ihr Endpoint schlägt zu oft fehl? Prüfen Sie mit Webhooks auflisten den Status. Mit Alle fehlgeschlagenen erneut senden reihen Sie Verpasstes erneut ein.