Browse all Help Center topics
Help Center / Automation & integrations / API keys and webhooks
API keys and webhooks
Connect Orbinly to your own tools with a REST API and signed real-time webhooks.
Developers (or you, with a no-code tool) can read and create data in Orbinly and react to events in real time. This is on the Starter plan and above, under Settings → Developer. Full reference: API & webhooks docs.
API keys
- Press to generate a key. Copy it straight away; it's shown only once.
- A key stands for your whole agency, and everything it touches is automatically limited to your agency.
- Send it as
Authorization: Bearer <key>. Revoke and regenerate whenever you need.
The API covers clients, projects, tasks and invoices: list, retrieve, create and update. List requests accept limit (up to 100) and offset, and return newest first.
Webhooks
Add an endpoint URL, choose events, and Orbinly sends your URL a JSON message the moment they happen.
| Event | Fires when |
|---|---|
| client.created | A client is added |
| project.created | A project is created |
| project.status_changed | A project's status changes |
| invoice.created | An invoice is created |
| invoice.paid | An invoice is paid |
| invoice.overdue | An invoice becomes overdue |
| proposal.accepted / proposal.rejected | A client responds to a proposal |
| contract.accepted / contract.rejected | A client responds to a contract |
- Each delivery is signed: check the
X-Orbinly-Signatureheader against your endpoint's secret (shown once, when you create the endpoint). - Failed deliveries are retried automatically, up to 5 attempts.
- The Developer page lists recent deliveries so you can see what was sent.
Treat API keys and signing secrets like passwords. If one is exposed, revoke it and create a new one.
Didn't find what you needed?
Our team responds to every message personally.