API Changelog

RSS

Every change to the SigPen API and its documentation, newest first.

v1 is additive-only. We add fields and endpoints in a backward-compatible way, so existing integrations keep working. Any breaking change would ship under a new version with advance notice, never silently.

Per-resource API reference

June 11, 2026
  • NewThe API reference is now generated from the OpenAPI spec, with a dedicated page per resource under /docs/api/<resource>: Documents, Signing, Embedded Signing, Templates, Webhooks, Bulk Send, Forms Library, and Account.
  • NewMachine-readable spec published at /openapi.json (the YAML original stays at /openapi.yaml).
  • NewSpec now documents signers[].fields inline placement and the bulk-send skip_email and subject parameters.
  • Newskip_email on POST /documents/:id/send: create signing sessions without invitation emails, completing the embedded-signing flow (embed.js + embedded-sign-url) without the legacy template endpoint.

Documentation corrections and hidden capabilities

June 10, 2026
  • NewDocumented inline field placement on send: signers[].fields places signature/text/date boxes per signer with no editor step.
  • NewDocumented the webhook delivery envelope, all four delivery headers, the test.webhook event, and the retry/auto-disable policy.
  • NewAdded reference entries for POST/PATCH/DELETE /templates, GET/PATCH /webhooks/:id, and POST /webhooks/:id/test.
  • FixedThe from-form sample now uses form_id; removed the unimplemented subject, reminder_frequency, and signers[].role send parameters (reminders are automatic after 48h); validation errors return 422, not 400.

Signer visibility and template improvements

June 4, 2026
  • NewAdded the document.viewed and document.declined webhook events. A signer declining now voids the document.
  • NewSigner objects now include a viewed_at timestamp and a declined status; signer status values are pending, viewed, signed, declined.
  • NewGET /account now reports the effective rate limit for the key plus a mode of test or live.
  • NewDocumented the embedded signing widget callbacks (onReady, onSign, onDecline, onError) and the { source, event } postMessage shape.
  • NewAuto date-signed fields: set auto_date_signed: true on a date field in POST /templates to auto-stamp each signer’s completion date (read-only).

CRM correlation and template roles

June 3, 2026
  • NewAdded external_id and metadata on documents, returned in every webhook payload for CRM correlation.
  • NewAdded template field roles: PATCH /templates/:id with field_roles, and role_assignments on from-template.

v1.0: initial public release

March 29, 2026
  • NewInitial public release: documents, templates, sending, embedded signing, bulk send, forms, and webhooks.
Looking for the reference? Start at the API documentation or grab the openapi.json.