Skip to main content

Endpoint

Headers

Request body

See the payload schema for the full field reference.

Response

Success — new deployment (201)

Success — updated existing (200)

When a deployment with the same deploymentId already exists:

Validation error (400)

Authentication error (401)

Organization mismatch (403)

When organizationSlug in the payload does not match the key’s organization:

Behavior

Idempotency

The deploymentId field is the idempotency key. Sending the same deploymentId twice updates the existing record rather than creating a duplicate. This is safe for retries.

PR linking

On successful production deployments, Periscope automatically links the deployment to merged PRs using the commitSha and calculates lead time for each linked PR.

Free trial

If your organization is on the Free plan, the first deployment event starts a 14-day Business trial.

Example