Skip to main content

API changes

2026-05-04

  • Documentation realignment. Renamed the public surface from documents/recipients to envelopes/signers across all docs. Single-host model documented (https://api.permissio.us). Bearer-only authentication documented; references to X-API-Key/X-Permissio-Key removed. Flat error envelope documented (error, code, request_id, details?). Webhook headers updated to Permissio-Signature / Permissio-Delivery-Id / Permissio-Event. Webhook event catalog updated to envelope.* / signer.signed. Pagination documented as limit + offset. Idempotency contract documented (Idempotent-Replayed, 425 idempotency_in_progress).

2026-05-03

  • Added template_version parameter to POST /v1/envelopes for pinning a template to a specific version.
  • Webhook payloads now include the env field, distinguishing sandbox and production traffic.

2026-04-12

  • Added the envelope.expired event.
  • GET /v1/events now supports filtering by type.