Skip to content

Webhooks

Receive real-time notifications when invoices move through delivery, or when platform sub-tenants change lifecycle state.

Setup

Configure your webhook endpoint in the getpeppr console under Settings → Webhooks. getpeppr will send a POST request to your endpoint for each event.

Requirements

  • Your endpoint must accept POST requests with application/json body
  • Respond with a 2xx status code within 5 seconds
  • Use HTTPS in production

Event Types

EventDescription
invoice.sentInvoice successfully delivered to recipient's access point
invoice.acceptedRecipient accepted the invoice
invoice.refusedRecipient rejected the invoice
invoice.errorDelivery failed (final state)
invoice.registeredCleared by tax authority (e.g., KSA, PT)
invoice.receivedReceipt acknowledged by recipient
invoice.paidPayment confirmed by recipient
invoice.undeliverableNot deliverable — no receiving capability found for the recipient on the Peppol network. The payload carries status: "no_action" (final state for the send). Also sent when no delivery evidence has appeared after 7 days — that window is our own policy, not a verdict from the network
invoice.delivery_unconfirmedNo delivery evidence yet for a document we accepted. This is not a failure: if delivery is confirmed later, invoice.sent follows normally and supersedes it. We send it so that silence reaches you from us rather than from your own timer
invoice.partially_paidRecipient confirmed a partial payment
invoice.under_queryRecipient raised a question about the invoice — clarification expected before acceptance
invoice.conditionally_acceptedRecipient accepted the invoice subject to conditions
invoice.status_changedGeneric status notification carrying the full per-axis state — opt-in: never matched by the * wildcard, subscribe to it explicitly. See invoice.status_changed
legal_entity.registeredPlatform sub-tenant reached a verified or active state
legal_entity.verification_failedPlatform sub-tenant registry verification failed
legal_entity.awaiting_authzPlatform sub-tenant authorisation email is awaiting customer action
legal_entity.registration_failedPlatform sub-tenant identity verified but network (SMP) registration failed
peppol_identifier.verifiedA Peppol identifier completed registry verification
peppol_identifier.verification_failedA Peppol identifier failed registry verification
test.pingTest event sent during endpoint setup
inbound.invoice.receivedAn invoice addressed to your Legal Entity was received from the Peppol network (pilot — contact support to enable)
inbound.creditnote.receivedA credit note addressed to your Legal Entity was received from the Peppol network (pilot — contact support to enable)
*Wildcard — subscribes to all event types except invoice.status_changed (opt-in only)

invoice.status_changed

invoice.status_changed is a generic status notification dispatched on every provider status update for a sent document, alongside the specific historic event (invoice.accepted, invoice.paid, …). Where the historic events tell you what happened, status_changed carries the full resulting state: the legacy status plus a per-axis breakdown (axes) and, when the jurisdiction provides one, the structured national detail (detail) with the native code preserved (e.g. a French DGFiP lifecycle code).

Opt-in only. A * wildcard subscription never receives invoice.status_changed — you must list it explicitly in the endpoint's events. This guarantees wildcard subscribers get exactly one notification per status update, never two.

Stable event ids. Status events (historic and status_changed) carry a deterministic id derived from the underlying provider occurrence: if the provider redelivers the same status update, you receive the same event id again. Deduplicate by id on your side — deliveries are at-least-once.

axes values are nullable — an axis is null until a status update touches it. detail is omitted when no structured national detail exists for the document. The status field uses the same vocabulary as Document Status.

invoice.status_changed
{
  "id": "evt_9f2c8a41d3b7e650",
  "type": "invoice.status_changed",
  "data": {
    "invoiceId": "8b3f2c1d-4a5e-4f6b-9c8d-7e6f5a4b3c2d",
    "submissionId": "8b3f2c1d-4a5e-4f6b-9c8d-7e6f5a4b3c2d",
    "invoiceNumber": "INV-2026-001",
    "providerDocumentId": "storecove-guid-abc123",
    "status": "delivered",
    "environment": "production",
    "axes": {
      "platformFiscal": "submitted_to_network",
      "delivery": "delivered",
      "businessDisposition": null,
      "settlement": null
    },
    "detail": {
      "delivery": {
        "axis": "delivery",
        "jurisdiction": "*",
        "code": "succeeded",
        "label": "Delivered",
        "codeSystem": "peppol-transport",
        "codeVersion": "1"
      }
    }
  },
  "createdAt": "2026-07-14T10:05:00.000Z"
}

Platform Lifecycle Webhooks

Platform accounts receive the legal_entity.* events above on the same endpoint delivery channel as invoice webhooks: signed with Getpeppr-Signature, retried automatically, and filterable with the same event subscriptions.

  • subTenantId maps back to the externalSubTenantId you supplied when creating the customer.
  • legalEntityId is the getpeppr legal entity id for follow-up API calls.
  • status is one of verified, verification_failed, awaiting_authz, or active.
  • environment tells you whether the transition happened in sandbox or production.
For the full multi-tenant sending flow, including sender.externalSubTenantId and production send gates, see Platform Sending & Webhooks.
legal_entity.registered
{
  "id": "evt_1a2b3c",
  "type": "legal_entity.registered",
  "data": {
    "subTenantId": "customer_8412",
    "legalEntityId": "7c9a1b34-2d5e-4f60-8a1b-9c2d3e4f5a6b",
    "peppolId": "GB:VAT:gb123456789",
    "status": "active",
    "environment": "production",
    "occurredAt": "2026-06-01T10:05:00.000Z"
  },
  "createdAt": "2026-06-01T10:05:00.000Z"
}

Inbound Reception (Pilot)

Inbound reception is a pilot feature. Contact support@getpeppr.dev to enable it for your account.

When a supplier on the Peppol network sends an invoice or credit note to one of your Legal Entities, getpeppr stores the document and dispatches one of these events:

  • inbound.invoice.received — an invoice addressed to your Legal Entity arrived
  • inbound.creditnote.received — a credit note addressed to your Legal Entity arrived
Not to be confused with invoice.received — that existing outbound event means “a document you sent was acknowledged by the recipient’s access point”. The inbound.* events mean a document was sent to you by a third party.

Document embed

The UBL XML content is embedded in the webhook payload as a base64-encoded string (field data.document.content). Documents larger than 512 KB are stored but not embedded: content will be null and contentOmittedReason will be "size". Fetch those — and any document you did not persist — with GET /v1/received-documents/{id}/as/xml, which returns the original UBL byte for byte. Use data.receivedDocumentId as the id.

Deduplication

Delivery is at-least-once. Deduplicate on data.receivedDocumentId — it is the stable idempotency key for inbound events: one received document, one id, however many times it is delivered. event.id only identifies a single delivery attempt of one outbox row and does not dedupe duplicates created by internal redelivery repair (the same document can arrive under different event.id values).

inbound.invoice.received
{
  "id": "evt_def456ghi789",
  "type": "inbound.invoice.received",
  "data": {
    "receivedDocumentId": "9f1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
    "legalEntityId": "7c9a1b34-2d5e-4f60-8a1b-9c2d3e4f5a6b",
    "externalSubTenantId": "customer_8412",
    "documentType": "invoice",
    "sender": {
      "peppolId": "0208:0123456789",
      "name": "Supplier SA"
    },
    "invoiceNumber": "INV-123",
    "receivedAt": "2026-06-11T08:00:00.000Z",
    "providerDocumentId": "storecove-guid-abc123",
    "document": {
      "format": "ubl",
      "encoding": "base64",
      "content": "<base64 UBL XML>",
      "contentOmittedReason": null,
      "sizeBytes": 12345
    }
  },
  "createdAt": "2026-06-11T08:00:01.000Z"
}

Handler Example

Here's a complete webhook handler using the SDK types. The WebhookEvent type ensures type safety for all event payloads.

import { webhooks } from "@getpeppr/sdk";
import type { WebhookEvent } from "@getpeppr/sdk";

// In your Express / Hono / Fastify route handler
app.post("/webhooks/peppol", async (req, res) => {
  // 1. Verify the signature (critical for security)
  let event: WebhookEvent;
  try {
    event = await webhooks.constructEvent(
      req.body,              // raw body string (NOT parsed JSON)
      req.headers["getpeppr-signature"] as string,
      "whsec_your_secret"    // from dashboard
    );
  } catch (err) {
    console.error("Signature verification failed:", err);
    return res.status(400).send("Invalid signature");
  }

  // 2. Handle the event
  switch (event.type) {
    case "invoice.sent":
      console.log(`Invoice ${event.data.invoiceId} delivered!`);
      break;

    case "invoice.accepted":
      console.log(`Invoice ${event.data.invoiceId} accepted!`);
      break;

    case "invoice.refused":
      console.error(`Invoice ${event.data.invoiceId} refused`);
      break;

    case "invoice.error":
      console.error(`Invoice ${event.data.invoiceId} delivery failed`);
      break;

    case "invoice.paid":
      console.log(`Invoice ${event.data.invoiceId} paid!`);
      break;
  }

  // 3. Always respond quickly — process async if needed
  res.status(200).send("ok");
});

// Event types:
// "invoice.sent"       — delivered to recipient's access point
// "invoice.accepted"   — recipient accepted the invoice
// "invoice.refused"    — recipient rejected the invoice
// "invoice.error"      — delivery failed (final state)
// "invoice.registered" — cleared by tax authority
// "invoice.received"   — receipt acknowledged by recipient
// "invoice.paid"       — payment confirmed by recipient
// "inbound.invoice.received"    — an invoice addressed to your Legal Entity arrived
// "inbound.creditnote.received" — a credit note addressed to your Legal Entity arrived
// "legal_entity.registered"          — sub-tenant reached verified/active
// "legal_entity.verification_failed" — sub-tenant registry check failed
// "legal_entity.awaiting_authz"      — sub-tenant authorisation requested
// "test.ping"          — test event for setup verification

Payload Format

Every webhook request contains a JSON body with the following structure:

  • id — unique event ID (identifies one delivery; for inbound events deduplicate on data.receivedDocumentId instead)
  • type — event type string
  • data — event-specific payload
  • createdAt — ISO 8601 timestamp
Webhook Payload
{
  "id": "evt_abc123def456",
  "type": "invoice.sent",
  "data": {
    "invoiceId": "8b3f2c1d-4a5e-4f6b-9c8d-7e6f5a4b3c2d",
    "submissionId": "8b3f2c1d-4a5e-4f6b-9c8d-7e6f5a4b3c2d",
    "invoiceNumber": "INV-2026-001",
    "providerDocumentId": "storecove-guid-abc123",
    "status": "delivered",
    "environment": "sandbox"
  },
  "createdAt": "2026-03-01T10:05:00.000Z"
}

Security

Every webhook request carries a Getpeppr-Signature header. Verify it on your endpoint to prove the request came from getpeppr and was not tampered with in transit.

The signing secret

Each endpoint you register gets its own signing secret (prefixed whsec_), shown once when you create it under Settings → Webhooks. Copy it then — it is masked on every later view, and secrets are not rotatable: to replace one, delete the endpoint and create a new one.

There is no separate “sandbox” secret. The same per-endpoint whsec_ signs every event to that endpoint in both sandbox and production, so your verification code keeps working unchanged when you later move a participant to production.

Signature format

The header value has the shape t={unix_seconds},s={hmac_sha256_hex}, for example t=1751458504,s=d9b60cb5…:

  • t — Unix timestamp (in seconds) at which the event was signed
  • s — the signature: HMAC-SHA256(secret, "{t}.{rawBody}"), hex-encoded

The signed message is the timestamp, a literal ., then the raw request body — exactly the bytes you received. Recompute the HMAC with your secret and compare it to s.

Verify with the SDK (recommended)

await webhooks.constructEvent(rawBody, signatureHeader, secret) from @getpeppr/sdk does everything in one call — header parsing, the HMAC, a constant-time comparison, and a 5-minute replay-tolerance check — and throws if any step fails. See the Handler Example above.

Verify without the SDK

Any language with an HMAC library can verify the signature. In Node.js:

verify.ts
import crypto from "node:crypto";

/** Verify an incoming getpeppr webhook. Throws if the signature is invalid. */
function verifyGetpepprSignature(
  rawBody: string,          // the exact raw request body (a string, NOT parsed JSON)
  signatureHeader: string,  // the Getpeppr-Signature header value
  secret: string,           // your endpoint's whsec_ signing secret
  toleranceSeconds = 300,
): unknown {
  const match = signatureHeader.match(/t=([^,]+),s=(.+)/);
  if (!match) throw new Error("Malformed Getpeppr-Signature header");
  const [, timestamp, received] = match;

  // Replay protection: reject events older than the tolerance window.
  const age = Math.abs(Math.floor(Date.now() / 1000) - Number(timestamp));
  if (!Number.isFinite(Number(timestamp)) || age > toleranceSeconds) {
    throw new Error("Timestamp outside tolerance");
  }

  // Recompute HMAC-SHA256 over "{timestamp}.{rawBody}" and compare in constant time.
  const expected = crypto
    .createHmac("sha256", secret)
    .update(timestamp + "." + rawBody)
    .digest("hex");
  const ok =
    received.length === expected.length &&
    crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected));
  if (!ok) throw new Error("Invalid signature");

  return JSON.parse(rawBody); // safe to trust and parse now
}

Common pitfalls

  • Hash the raw body — verify against the exact bytes received, before any JSON parsing. Re-serialising the parsed object (key order, whitespace) changes the HMAC and makes a valid signature look invalid. This is the most common cause of a false “invalid signature”.
  • Keep your clock in sync — verification rejects events older than 5 minutes as replay protection, so a drifting server clock fails legitimate webhooks. Run NTP.
  • Deduplicate — delivery is at-least-once. Use the stable resource key in data (for inbound events, data.receivedDocumentId); event.id identifies a single delivery attempt, not the document.
  • Respond quickly — return 2xx within 5 seconds and process asynchronously; failed deliveries are retried with backoff.
Never trust an unverified payload. Without signature verification, an attacker who learns your endpoint URL could POST fake events to it.