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.

Periscope provides two APIs:

​
Deployment webhook API

The deployment webhook is a REST endpoint for ingesting deployment events from your CI/CD pipeline. It is the only write API that Periscope exposes to customers.
  • Base URL: https://app.periscope.sh/api/webhooks/deployments
  • Authentication: Bearer token (API key from Settings > Deployments)
  • Format: JSON

Authentication

How to authenticate with the deployment API using API keys.

Ingest deployment

Send a deployment event to Periscope.

Payload schema

Full field-by-field reference for the deployment payload.

​
MCP server

The MCP server provides read-only access to all Periscope metrics through the Model Context Protocol. It is designed for use with AI coding assistants rather than direct API calls.
  • URL: https://app.periscope.sh/mcp
  • Authentication: OAuth 2.0 via WorkOS
  • Protocol: MCP over HTTP
See the MCP integration guide for setup instructions and the full list of 18 available tools.