For developers
Link Agentryx One to anything: your own systems, Zapier, Make, or an AI assistant. There's a REST API, signed webhooks, and an MCP server for ChatGPT and Claude. All of it uses the same API key.
Start · API · Webhooks · Zapier · ChatGPT and Claude · Calendars, accounts and Teams
Getting a key
- The owner or a manager signs in and goes to Connections, then API, webhooks and AI assistants.
- Give the key a name (what it's for) and choose whether it can add jobs and customers, or only read.
- Copy it straight away. It's shown once. We keep a scrambled copy only, so we can't show it again. Lost it? Revoke it and make another.
Each key belongs to one business and sees only that business. Send it on every call:
curl https://one.agentryx.io/api/v1/me \
-H "Authorization: Bearer agx_your_key"Good to know: money is in pence and before VAT. Times are ISO 8601 in UTC. Lists come back as { data, limit, offset, more }. Errors come back as { error: { status, message } } with 400 (something's wrong in what you sent), 401 (no key or a revoked key), 403 (read-only key), 404 or 500.
The API
Base address: https://one.agentryx.io/api/v1
| GET | /me | The business the key belongs to, its job types and statuses. Use it to test a key. |
| GET | /jobs | Jobs, newest first. Filters: status (comma separated), from and to (YYYY-MM-DD, on the booked time), customer_id, worker_id, limit (up to 200), offset. |
| GET | /jobs/{id or number} | One job with its customer, site, engineer and recent history. |
| POST | /jobs | Log a job. customer_id and summary are needed. Optional: site_id or site { name, address, postcode }, type, priority (normal, urgent, emergency), starts_at, minutes, worker_id, value_pence, note. |
| GET | /customers | Customers with their sites. Filters: search (name, email or phone), limit, offset. |
| GET | /customers/{id} | One customer. |
| POST | /customers | Add a customer. name is needed. Optional: kind (homeowner, landlord, business, contract), phone, email, site { name, address, postcode }. |
| GET | /invoices | Invoices, newest first. Filters: status (draft, sent, overdue, paid, void), from and to (issued date), customer_id. |
| GET | /invoices/{id or number} | One invoice. |
| GET | /quotes | Quotes, newest first. Filters: status (draft, sent, viewed, accepted, declined, expired), customer_id. |
| GET | /quotes/{id or number} | One quote with its lines and options. |
| GET | /webhooks | Webhooks on the account, and the events you can subscribe to. |
| POST | /telemetry | Connected kit and fire panels: { asset (our id, its device id or serial), source, readings: [{ metric, value, unit, at }], alarms: [{ code, text, severity }], panel: [{ type: fire | fault | disablement | restore, zone, device, text }] }. Or { items: [...] } for several. Each event raises a job or an alert by the business's rules. |
| POST | /webhooks | Subscribe: { url, events: ["job.created", ...] }. Use "*" for everything. Returns the id and signing secret. |
| DELETE | /webhooks/{id} | Unsubscribe. |
Log a job from your website or another system:
curl -X POST https://one.agentryx.io/api/v1/jobs \
-H "Authorization: Bearer agx_your_key" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "6f1c…",
"summary": "No hot water, combi boiler showing F28",
"priority": "urgent",
"site": { "address": "14 Moss Lane", "postcode": "M33 6GH" }
}'A job comes back like this:
{
"id": "0b9e…", "ref": 1043, "type": "breakdown", "type_name": "Breakdown",
"status": "logged", "status_name": "Logged", "priority": "urgent",
"summary": "No hot water, combi boiler showing F28", "source": "api",
"customer": { "id": "6f1c…", "name": "Sarah Ahmed", "phone": "07700 900123", "email": null },
"site": { "id": "a71d…", "name": "Main site", "address": "14 Moss Lane", "postcode": "M33 6GH" },
"worker": null, "starts_at": null, "minutes": 60, "value_pence": null,
"created_at": "2026-11-16T09:12:44Z"
}Job types and statuses differ by industry (a care visit, a skip collection, a boiler service). GET /me lists the ones this business uses.
Webhooks
We send a POST to your address the moment something changes. Add one on Connections, or subscribe through the API. Each delivery carries the event and the full record:
POST https://your-system.example.com/agentryx
X-Agentryx-Event: job.status_changed
X-Agentryx-Delivery: evt_8812
X-Agentryx-Timestamp: 1763284364
X-Agentryx-Signature: v1=5d41402abc4b2a76b9719d911017c592…
{
"id": "evt_8812", "event": "job.status_changed", "created_at": "2026-11-16T09:12:44Z",
"business": { "id": "…", "name": "Northside Heating" },
"changes": { "ref": 1043, "from": "booked", "to": "on_site" },
"data": { …the job, same shape as GET /jobs/{id}… }
}call.urgent | Urgent call taken by the receptionist |
job.created | New job |
job.urgent | Urgent or emergency job (including urgent calls) |
job.status_changed | Job status changed |
job.scheduled | Job booked, moved or reassigned |
invoice.created | Invoice raised |
invoice.paid | Invoice paid |
invoice.status_changed | Invoice sent or overdue |
quote.created | Quote made |
quote.accepted | Quote accepted |
quote.declined | Quote declined |
quote.status_changed | Quote sent or viewed |
customer.created | New customer |
Checking it came from us. Work out an HMAC SHA-256 of timestamp + "." + the raw body with your webhook's signing secret, and compare it with the signature. Turn away anything older than 5 minutes.
import crypto from 'node:crypto'
function fromAgentryx(req, rawBody, secret) {
const ts = req.headers['x-agentryx-timestamp']
const sig = req.headers['x-agentryx-signature'] || ''
const want = 'v1=' + crypto.createHmac('sha256', secret).update(ts + '.' + rawBody).digest('hex')
const fresh = Math.abs(Date.now() / 1000 - Number(ts)) < 300
return fresh && sig.length === want.length && crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(want))
}Answer with any 2xx within 10 seconds. If nobody's answering, we try again on the next run, up to 5 times. A webhook that fails 25 times in a row is switched off and we tell the business. Events are sent within a few minutes, and straight away for jobs logged through the API or the AI receptionist.
Zapier
No app to install. Use Zapier's own Webhooks by Zapier with your key.
- In a new Zap, pick Webhooks by Zapier and Catch Hook. Copy the address Zapier gives you.
- In Agentryx One, go to Connections, Team alerts, pick Webhook, paste the address and tick the events you want (for example Invoice paid).
- Press Test next to it, then Test trigger in Zapier. The fields (job number, customer, amount) are then there to use in the next steps.
- Add a step: Webhooks by Zapier, Custom Request (or POST).
- Method POST, address
https://one.agentryx.io/api/v1/jobs(or/customers), data as JSON, and a headerAuthorizationwithBearer agx_your_key. - Map the fields from your trigger into
customer_id,summaryand so on.
Using Zapier's developer platform instead? Subscribe with POST /api/v1/webhooks and unsubscribe with DELETE /api/v1/webhooks/{id} (REST hooks). Use GET /api/v1/me as the auth test. Make and n8n work the same way with their HTTP and webhook modules.
ChatGPT, Claude and other AI assistants
Agentryx One has an MCP server, so an assistant can answer "what's on tomorrow?", "who owes us more than 30 days?" or "find the Ahmed job" from your real records. It reads. The one thing it can add is a new job, and only with a key that's allowed to add. Use a read-only key if you only want answers.
- Address:
https://one.agentryx.io/api/mcpwith the headerAuthorization: Bearer agx_your_key - For apps that only take an address:
https://one.agentryx.io/api/mcp/k/agx_your_key. Treat that address like a password.
- Claude (web and desktop): Settings, Connectors, Add custom connector. Paste the address with your key in it.
- Claude Code:
claude mcp add --transport http agentryx https://one.agentryx.io/api/mcp --header "Authorization: Bearer agx_your_key"
- Settings, Apps and Connectors, turn on Developer mode under Advanced, then Create a connector. Paste the address with your key in it and choose no sign-in.
business_overview | Today at a glance: jobs today, urgent jobs, jobs not booked yet, money owed and overdue (in pence), quotes waiting, plus the business's job types and statuses. |
list_jobs | Jobs, newest first. Filter by status ids (comma separated), a date range on the booked time (YYYY-MM-DD), a customer or an engineer. |
get_job | One job with its customer, site, engineer and recent history. Takes the job id or its number (e.g. 1042). |
search_customers | Customers whose name, email or phone matches, with their sites. |
get_customer | One customer with their sites. |
list_invoices | Invoices, newest first. Status is draft, sent, overdue, paid or void (comma separated). Amounts are in pence, before VAT. |
get_invoice | One invoice by id or number. |
list_quotes | Quotes, newest first. Status is draft, sent, viewed, accepted, declined or expired. |
get_quote | One quote by id or number, with its lines and options. |
log_job (adds) | Log a new job for an existing customer. It goes on the list to be booked by the office. Only works with an API key that has write access. Confirm the details with the person first. |
Calendars, accounts and Teams
- Calendar feed: every person has a private link (
https://one.agentryx.io/api/cal/…ics) that Google Calendar, Outlook and the iPhone calendar can subscribe to. Find it on Connections, or in the field app. - Accounts: Xero, Sage Accounting and QuickBooks Online connect directly. For Sage 50, Sage 200 and anything else, Connections has a download in Sage 50, QuickBooks or plain columns for any dates.
- Teams and Slack: paste a channel's webhook address on Connections to get a message for urgent calls and new jobs.
Questions or something missing? Use Report a problem in the app and we'll pick it up.