Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.steppd.com/llms.txt

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

The Inbox API is the only REST endpoint exposed by Steppd. It returns the latest published version of your organization’s SOPs in a structured format. Your inbox URL is unique to your organization, find it in Profile → API Keys. All requests require a valid API key passed as a Bearer token. See Authentication for setup instructions.

​
List all published documents

Returns the latest published payload for every document in your organization’s inbox.

​
curl example

curl YOUR_INBOX_URL \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Get a single published document

Append the document ID to your inbox URL to fetch a specific document.

​
curl example

curl YOUR_INBOX_URL/DOCUMENT_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
The DOCUMENT_ID is the document_id field present in webhook event payloads.

​
Response fields

Both endpoints return the same document payload shape.
​
document_id
string
The document ID.
​
title
string
The document title at the time of last publish.
​
version
string
The version string at the time of last publish.
​
department
string
The department name, if set.
​
published_at
string
ISO 8601 timestamp of the most recent publish.
​
published_by_email
string
Email of the member who last published the document.
​
sections
array
The full structured content of the document.

​
Example response

{
  "document_id": "doc_xyz789",
  "title": "Employee Onboarding Process",
  "version": "2.0",
  "department": "HR",
  "published_at": "2024-01-15T10:30:00Z",
  "published_by_email": "alice@example.com",
  "sections": [
    {
      "title": "Pre-arrival",
      "content": "",
      "images": [],
      "steps": [
        {
          "title": "Send welcome email",
          "content": "Use the onboarding email template and CC the hiring manager.",
          "images": [],
          "substeps": []
        }
      ]
    }
  ]
}