Skip to main content

Documentation Index

Fetch the complete documentation index at: https://documentation.outpost.pub/llms.txt

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

Invite only — The Integration API is available by invitation. Contact support@outpost.pub to request access for your publication.
If your tooling isn’t covered by Outpost’s built-in integrations, you can build your own integration against the Integration API. The API lets external tools and scripts read member data and (in approved cases) update it.

​
What’s available today

Outpost’s custom-integration story is API-based, not webhook-based. There is no outgoing-webhook product: Outpost does not POST to publisher-configured URLs when events happen. Instead, your integration polls the Integration API at the cadence that fits your workflow. If you need event-driven workflows for your own tools, run a regular polling job (every minute or every hour, depending on how fresh you need the data) and call the Integration API to get the latest member state.

​
Authentication

The Integration API authenticates with an API key scoped to your publication. Pass it on every request as either:
  • A query parameter: ?api_key=YOUR_KEY
  • A request header: Authorization: Bearer YOUR_KEY
Both are supported. Treat the key like a password — anyone with the key can read your member data.

​
Endpoints and full reference

See the Integration API Reference for the full list of endpoints, request and response shapes, error codes, and example requests.

​
Request your API key

Email support@outpost.pub with:
  • The publication name your key should be scoped to.
  • A short description of what you plan to build (helps us understand whether the Integration API covers your use case).
We provision API keys manually after a quick sanity check. Lead time is usually one business day.

​
Rate limits

The Integration API has usage limits per API key. If you’re running migrations or bulk operations and bump into them, contact support@outpost.pub — we can raise the limit for time-bound projects.

Integration API Reference

Full endpoint documentation and request/response examples.

Integrations Overview

Built-in integrations that may already cover your use case.

​
FAQ

Not today. Outpost does not POST events to publisher-configured URLs. Custom integrations poll the Integration API instead.
Indirectly. Both can call the Outpost Integration API on a schedule using their HTTP modules and the API key, which gets you Zapier/Make automation against polled data. There is no native Zapier or Make Outpost connector today.
Some endpoints accept writes (e.g. updating member labels or notes). Read the Integration API Reference for the per-endpoint details. Write access is granted carefully; let us know what you need to update when you request a key.