Skip to main content
Use the public API from your own portal or tools to list clients, forms and workflows, run Core forms, follow executions, act on approvals and receive events by webhook. Every endpoint is in the sidebar, with a playground to try it.

​
Get a key

Create a key in Triggr Core under Settings > API or in Studio under Settings > API Keys; both manage the same keys, and the key is shown once. See API and webhooks for rolling and revoking keys.
The Create API key dialog with Name Client portal and three scope checkboxes: Run Core forms natively core:run, ticked, Configure Core workflows core:configure, and Act on running work executions:manage.
Every key can read the catalogue and start form sessions. Tick a scope when you create the key if you need it; each endpoint’s page says which scope it needs.

​
Make a request

GET /api/v1/me returns the organisation the key belongs to, so it’s a quick way to check a key works.

​
Limits and conventions

  • Rate limits: 600 reads and 60 writes a minute per key, and 120 form-session starts a minute. Responses carry X-RateLimit-Limit and X-RateLimit-Remaining; a 429 carries Retry-After.
  • Paging: lists take limit (default 50, up to 100) and offset, and return total and hasMore. Executions and Core requests also take since (an RFC 3339 time).
  • Retrying safely: endpoints that start or decide something accept an optional Idempotency-Key header, so a retried request isn’t carried out twice.

​
Webhooks

Register a webhook to be told when executions finish, approvals are needed and more. See Add a webhook for events, signatures and retries.