Skip to main content

API Version

The current SSN API payload version is:

2026-03-24

Webhook payloads include this value in the payloadVersion field. Clients should store and log the version when processing webhook events.

Compatibility​

The API is intended to remain backward-compatible for existing client integrations.

Backward-compatible changes may include:

  • adding optional request fields
  • adding response fields
  • adding webhook event fields
  • adding new endpoints
  • adding new enum values where clients are expected to tolerate unknown values

Breaking changes require explicit client coordination before rollout.

Changelog​

2026-03-24​

  • Initial client-facing API payload version.
  • Supports OAuth client credentials authentication.
  • Supports Sites, Site Visits, Messages, file uploads, and Webhooks.
  • Includes sandbox and production environments.