Changelog and versioning

September 30, 2026: V2 documentation candidate

This documentation candidate covers the V2 contract bundled with this site. The source below identifies that contract revision. A candidate entry describes this preview; it does not announce a production release.

HTTP contract source: 81aa6461431cbef7c5913ca4f3fd3284c5502f95. Download the OpenAPI contract.

• The tutorial covers campaign creation, discovery, one monitor run and cleanup.
• Campaign deletion cancels removed non-monitor runs, retains observations, and pauses dependent monitors. Independent monitors continue. Explicit monitor deletion cancels its active runs.
• Monitors support an immediate run while paused.
• Membership removal retains the stable record ID for future lookup and add operations.
• The reference separates discovery, import and export from the run lifecycle.
• Discovery start overrides apply to one run and preserve saved campaign settings.
• Monitor targets and signal subjects describes the organization-owned model in this candidate.

See Migrate from V1 for the V1-to-V2 changes. Deployment can differ by environment. Use the API origin and key for the environment you intend to call.

October 1, 2026: API corrections in the unreleased candidate

• Monitor create and update reject unknown nested signal fields.
• HTTP 429 uses the V2 error envelope and preserves retry and rate-limit headers.
• Authentication distinguishes invalid credentials (401), database outages (503 with Retry-After) and unexpected faults (500).
• Conflicts expose cause-specific codes and details.retryable.
• Campaign responses expose criteria_editable.

These corrections precede the external V2 release. They do not announce a production deployment or start a deprecation notice.

October 17, 2026: resource permissions in the staging candidate

• Product operations use explicit resource read/write permissions instead of organization roles.
• Permissions explains presets, API-key owner limits, compound requirements and next-request revocation.
• Permission denials return 403 access_denied with the missing resource, action and operation.
• Responses can identify restricted embedded data. Campaign fields and counts can be null when their reads are restricted.
• Organization roles continue to govern administration and billing.

This entry describes the staging candidate. Production activation requires the reviewed migration and release window.

Versioning

The /v2 path identifies the major API version. Additive changes can ship without advance notice. Additions include fields, operations, enum values and error codes. Clients must ignore unknown response fields. Handle unknown enum values and error codes with a fallback.

A removal or an incompatible change requires at least 60 days' notice before it takes effect. Signal publishes the affected field or operation, its replacement and the earliest removal date in this changelog. A new major version can carry incompatible behavior.

Deprecation

A deprecated operation remains available during its notice period. The deprecation notice names the replacement and the earliest removal date. Signal supplies a Deprecation response header when an operation enters deprecation. Clients can log that header and alert the integration owner.

No V2 field or operation is currently announced as deprecated on this page. Current responses therefore do not promise a Deprecation header. The notice period applies when Signal announces a deprecation, not from the date on this documentation candidate.