Skip to content

newsletter ​

← All modules

1 endpoint.

POST /api/v1/newsletter/postal-webhook ​

Postal Webhook

Authenticated by EITHER Postal's RSA signature over the raw body (X-Postal-Signature-256 / X-Postal-Signature, verified against the installation's public key — see postal_client.verify_webhook_signature) OR the legacy ?key= shared secret in the URL. The signature is the real proof (only our Postal holds the private key, and it cannot leak through a log line the way a URL key can); ?key= stays accepted during the transition because the webhook URLs configured on Postal still carry it. Once every Postal webhook is confirmed signing, the key can be dropped from those URLs without a code change here.

Parameters

NameInRequiredTypeDescription
keyquerynostring

200 — Successful Response

json
{}

422 — Validation Error

json
{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Lubb Business Documentation