API or webhook?
| Public API | Webhook | |
|---|---|---|
| Who initiates? | Your system asks. | Pagioo notifies. |
| When does it run? | When you call it. | When the event happens. |
| What is it for? | Reading data, triggering an operation. | Reacting immediately to something. |
| Typical example | Generating a monthly report from published content. | Creating a record in an internal system after a publish. |
Typical use cases
- Pushing content state into an internal system — so project management can see where things stand.
- Handling a publishing event — a notification on an internal channel, or a record in a register.
- Feeding your own portal or CMS — where publishing is driven by your system.
- A bespoke reporting or alerting process — your own figures built from Pagioo's data.
What you need to start
The Scale plan
The public API and webhooks are available on Scale.
An access key
Generated in Settings. The key acts on behalf of your account, so treat it like a password.
A webhook endpoint
An address you operate that receives the notifications. Verify the authenticity of incoming requests.
The developer documentation
Endpoints, events, limits and error codes are in the developer documentation. Ask us for it if you are on Scale.
Is the API available on a smaller plan?
No, the public API and webhooks are on Scale. Outbound custom API publishing is available on smaller plans.
Are there call limits?
Yes — rate limits and the support envelope are defined in the developer documentation.
What happens if my webhook endpoint does not respond?
The system logs the failed notification. It is therefore worth responding quickly at the endpoint and doing the real processing afterwards, in your own background job.