> ## Documentation Index
> Fetch the complete documentation index at: https://developers.papelship.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Empfangen Sie signierte Ereignisse, wenn sich Bestellungen, Produkte, Bewertungen und Affiliate-Datensätze ändern.

Webhooks senden einen HTTP-`POST` an Ihren Server, wenn in Ihrem Shop etwas passiert, sodass Sie nicht regelmäßig abfragen müssen.

Erstellen Sie Endpunkte unter **Entwickler › Webhooks** oder mit [`POST /webhooks`](#endpunkte-mit-der-api-verwalten).

## Ereignisse

| Ereignis | Zeitpunkt |
| :- | :- |
| `order.created` | Eine Bestellung wird erstellt (Storefront, API oder Embed). |
| `order.completed` | Eine Bestellung wird bezahlt und ausgeliefert. Enthält die Lieferungen. |
| `order.partially_paid` | Ein Teil einer Kryptozahlung ist eingegangen. |
| `order.manual_review` | Eine manuelle Zahlung wartet auf Ihre Prüfung. |
| `order.expired` | Eine Bestellung wurde nicht rechtzeitig bezahlt. |
| `order.cancelled` | Eine unbezahlte Bestellung wurde storniert. |
| `order.refunded` | Eine Rückerstattung wurde erfasst. Wird einmal pro erstattetem Betrag gesendet. |
| `product.out_of_stock` | Ein Produkt ist ausverkauft. |
| `product.low_stock` | Eine Variante eines physischen Produkts hat ihren Mindestbestand erreicht. Enthält `variant_id` und `threshold`. |
| `product.restocked` | Der Lagerbestand eines Produkts wurde aufgefüllt. |
| `product.deleted` | Ein Produkt wurde gelöscht. |
| `review.created` | Ein Kunde hat eine Bewertung hinterlassen. |
| `question.created` | Ein Kunde hat auf einer Produktseite eine Frage gestellt. |
| `question.answered` | Ihr Team hat eine Produktfrage beantwortet (Dashboard oder API). `answer.first` ist `true` für die erste Antwort. |
| `customer.created` | Ein neuer Kunde wurde Ihrem Shop hinzugefügt. |
| `withdrawal.completed` | Eine Wallet-Auszahlung wurde gesendet. |
| `affiliate.partner_applied` | Jemand hat sich für Ihr Affiliate-Programm beworben. |
| `affiliate.conversion` | Eine zugeordnete Bestellung wurde abgeschlossen und die Provision erfasst. |
| `affiliate.payout_requested` | Ein Partner hat eine Auszahlung angefordert. |
| `affiliate.payout_sent` | Sie haben eine Auszahlung als gesendet markiert. |

`GET /events/types` liefert dieselbe Liste.

## Payload

```json theme={"system"}
{
  "id": "evt_9b2c4f1a7d",
  "object": "event",
  "type": "order.completed",
  "created": 1791100000,
  "livemode": true,
  "store": { "id": "0bHQn0bU2dei", "name": "Acme", "slug": "acme" },
  "data": {
    "object": {
      "object": "order",
      "id": "c35ffd-19a1b2c3d4e-8c7a20",
      "status": "completed",
      "currency": "USD",
      "total": 34.99,
      "customer": { "email": "buyer@example.com", "country": "GB" },
      "items": [{ "product_id": "a1B2c3D4e5F6", "name": "Pro License", "quantity": 1, "unit_price": 34.99, "total": 34.99 }],
      "paid_at": "2026-10-04T12:03:00.000Z"
    }
  }
}
```

> [!NOTE]
>
> Beträge in Webhooks werden in der Hauptwährungseinheit angegeben (`34.99`), anders als in der API, die die kleinste Währungseinheit verwendet (`3499`).

## Signatur prüfen

Jeder Request enthält diese Header:

| Header | Wert |
| :- | :- |
| `PapelShip-Signature` | `t=<unix seconds>,v1=<hex HMAC>` |
| `PapelShip-Event-Id` | Die Ereignis-ID. Verwenden Sie sie, um Duplikate zu ignorieren. |
| `PapelShip-Event-Type` | Der Ereignistyp. |
| `PapelShip-Delivery-Attempt` | 1 beim ersten Versuch. |

Die Signatur ist `HMAC-SHA256(secret, "<t>.<raw body>")` in Hex. Das Secret (`whsec_...`) wird angezeigt, wenn Sie den Endpunkt erstellen. Berechnen Sie sie über den **unveränderten** Body, bevor Sie das JSON parsen, und lehnen Sie alte Zeitstempel ab.

```javascript Node.js theme={"system"}
import crypto from "node:crypto";

export function verify(rawBody, header, secret, toleranceSec = 300) {
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const t = Number(parts.t);
  if (!t || Math.abs(Date.now() / 1000 - t) > toleranceSec) return false;
  const expected = crypto.createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
  const a = Buffer.from(expected);
  const b = Buffer.from(parts.v1 || "");
  return a.length === b.length && crypto.timingSafeEqual(a, b);
}
```

```python Python theme={"system"}
import hmac, hashlib, time

def verify(raw_body: bytes, header: str, secret: str, tolerance: int = 300) -> bool:
    parts = dict(p.split("=", 1) for p in header.split(","))
    t = int(parts.get("t", 0))
    if not t or abs(time.time() - t) > tolerance:
        return False
    expected = hmac.new(secret.encode(), f"{t}.".encode() + raw_body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected, parts.get("v1", ""))
```

```php PHP theme={"system"}
function verify(string $rawBody, string $header, string $secret, int $tolerance = 300): bool {
    parse_str(str_replace(',', '&', $header), $parts);
    $t = (int)($parts['t'] ?? 0);
    if (!$t || abs(time() - $t) > $tolerance) return false;
    $expected = hash_hmac('sha256', $t . '.' . $rawBody, $secret);
    return hash_equals($expected, $parts['v1'] ?? '');
}
```

## Antworten und Wiederholungen

* Antworten Sie innerhalb von 10 Sekunden mit einem beliebigen `2xx`-Status. Erledigen Sie langsame Arbeit erst nach Ihrer Antwort.
* Fehlgeschlagene Zustellungen werden nach 1 Minute, 5 Minuten, 30 Minuten, 2 Stunden, 6 Stunden und 12 Stunden wiederholt (7 Versuche über etwa 21 Stunden).
* Ein Endpunkt wird nach 40 aufeinanderfolgenden Fehlschlägen ohne Erfolg innerhalb von 3 Tagen deaktiviert. Aktivieren Sie ihn im Dashboard oder mit `PATCH /webhooks/{id}` und `enabled: true` wieder.
* Dasselbe Ereignis kann mehrmals eintreffen. Verwenden Sie `PapelShip-Event-Id`, um es nur einmal zu verarbeiten.

## Endpunkte mit der API verwalten

```bash theme={"system"}
curl -X POST https://app.papelship.com/api/v1/webhooks \
  -H "x-api-key: pk_live_your_key" \
  -H "x-store-hash: your_store_id" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/webhooks/papelship", "events": ["order.completed", "order.refunded"] }'
```

Die Antwort enthält das Signatur-`secret`. Es wird nur einmal angezeigt; speichern Sie es in der Umgebung Ihres Servers.

| Endpunkt | Verwendung |
| :- | :- |
| `GET /webhooks` | Endpunkte mit Zustellstatistiken der letzten 7 Tage auflisten. |
| `PATCH /webhooks/{id}` | URL, Ereignisse oder `enabled` ändern. |
| `POST /webhooks/{id}/test` | Ein Beispielereignis senden. |
| `GET /events/deliveries` | Zustellprotokoll mit Status und Antwortcodes. |
| `POST /events/deliveries/{id}/resend` | Eine Zustellung erneut senden. |

Das Rotieren des Secrets erfolgt weiterhin im Dashboard.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.