Skip to main content

API Version and Release Notes

These identifiers describe different parts of the integration:

IdentifierCurrent valueMeaning
REST route version/api/v1Version of the HTTP endpoint namespace
OpenAPI document version1.0.0Reference document's info.version; not a deployment or webhook signature identifier
Webhook payloadVersion2026-03-24Event-body contract identifier; record it when processing events
Subscription signingVersionv1 or legacySignature algorithm/input contract configured for that subscription
Resource meta.version / ETagVaries by resourceResource update version, not an API release version

New subscriptions use v1 signing. Existing subscriptions remain legacy until an explicit upgrade with a supplied secret; a routine secret rotation preserves the signing version. A signing upgrade does not change the REST namespace or webhook payloadVersion. Follow the webhook guide for verification and coordinated migration.

Compatibility​

Clients should tolerate additional response/event fields. Optional fields and new endpoints may be added without changing /api/v1. Treat unexpected enum values explicitly rather than assuming every future value is known.

Breaking contract changes require client coordination. A version label alone is not a guarantee of stronger retry or concurrency protection; use the current operation-specific rules.

Release notes​

The dates below are repository merge dates for the identified changes, not promises about every environment's deployment time. This is a focused history of recent integration-facing changes, not an exhaustive historical log.

2026-09-23​

  • Onboarding recovery and packets: explicit validation dates, retained record IDs, partial-result recovery, and handoff references that distinguish provided from verified values.
  • Webhook guidance and admin organization: registration/verification/recovery guidance and separate new-client, existing-client, and webhook operations views.

2026-09-22​

  • Current ownership checks: resource access is checked against current upstream tenant ownership, including associated files and create replays.
  • Durable webhook enqueue recovery: saved delivery work can recover task-submission failures within a bounded budget. Queue submission does not confirm receiver delivery.
  • Webhook destinations: public HTTPS on port 443, validated and pinned DNS destinations, and no redirect following.
  • Versioned webhook signatures: timestamped v1 signatures for new subscriptions and explicit migration for existing subscriptions.
  • Error responses and retry guidance: invalid tokens return 401, rate-limit rejection returns 429, and retry guidance distinguishes resource creates, updates, uploads, and subscriptions.

Webhook payload baseline​

The current event-body identifier remains 2026-03-24. Recent releases above did not create a new payload version. See Webhooks for the event contract and API Reference for endpoint schemas and scopes.