Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.periscope.sh/llms.txt

Use this file to discover all available pages before exploring further.

The deployment webhook API uses Bearer token authentication with API keys.

​
Generating an API key

  1. Sign in to the Periscope dashboard (join the waitlist if you don’t have access yet)
  2. Navigate to Settings > Deployments
  3. Click Generate API Key
  4. Copy the key immediately
The API key is shown only once. If you lose it, you will need to generate a new one. The old key remains active — you can revoke it from the settings page.

​
Using the API key

Include the API key in the Authorization header of every request: 
curl -X POST https://app.periscope.sh/api/webhooks/deployments \
  -H "Authorization: Bearer psk_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

​
Key properties

PropertyDetails
ScopeEach key is scoped to a single organization
Rate limitingContact support for rate limit details
RevocationKeys can be revoked from Settings > Deployments
FormatKeys are prefixed for identification (e.g., psk_live_...)

​
Organization resolution

The API key determines which organization the deployment is recorded for. You do not need to include an organization identifier in the payload. If you optionally include organizationSlug in the payload, Periscope validates that it matches the key’s organization. This is a safety check to prevent accidental cross-organization ingestion.

​
Error responses

StatusMeaning
401 UnauthorizedMissing or invalid API key
403 ForbiddenKey is valid but the organization slug does not match
429 Too Many RequestsRate limit exceeded