Developers
Alori API
Read and import your records, send texts and emails, book meetings, and hear about changes with webhooks. Record types you added to your app work too. Your app's docs list them with their fields.
Changed your app?
If you added record types or fields in Build mode, or changed your app in any other way, your docs differ from this page. They list every type and field your app has, with examples.
Sign in to see your docs →Get started
- 1
Make a key. In Alori, open Connectors, then API, and click New key. Copy it: it's shown only once.
- 2
Send a customer. Run this request with your key. It adds Marie Tremblay to your CRM.
curl -X POST https://api.alori.dev/v1/objects/customers/batch \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "records": [ { "externalId": "cust-1001", "fields": { "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123" } } ] }' - 3
See it in your CRM. She shows in Customers right away. Under Recent imports on Connectors → API, you can undo the whole import.
How it works
- Your ids
- Give each record an
externalId: the id it has in your old tool. Send the same one again and Alori updates the record instead of making a copy, so a retry is always safe. - Linking records
- Point to another record with
{ "externalId": "…" }(one you imported),{ "id": "…" }(one already in Alori) or{ "email": "…" }(a customer, or a teammate for fields likeownerId). - Order
- Send parents before the records that point to them: custom fields, companies, customers, contacts, pipelines, deals, price items, quotes, jobs, invoices, notes, communications, then tasks.
- Values
- Money and numbers can be text (
"1 650,00 $"). Dates are ISO text ("2026-03-04"or"2026-03-04T09:30:00-05:00"). Set a field tonullto clear it. Custom fields go incustom. - Matching
- A record you haven't sent before is matched to one already in Alori: a customer by email or phone, a company by domain or name, a price item by name, a quote or invoice by number. Send
"match": "externalId"to always create a new one. - Test first
- Add
"dryRun": trueto check every record without saving anything. The answer lists the problems, field by field. - Imports and undo
- Each request is an import you can undo. To group several requests into one import, send the
runIdyou got back in anX-Alori-Runheader. Undo removes what the import added and keeps records your team has worked on since. - Keys
- A Reports key reads, an Import key imports. A Full access key does both, and also sends texts and emails, tags, moves deals, books and blocks time, and manages webhooks: it’s the one for your own software.
- Your own records
- Record types you added to your app in Build mode work like the built-in ones: read, create, update, delete and webhooks.
GET /v1/objectslists them withcustom: true, under their table name. - Limits
- Up to 500 records per request and 120 requests a minute per key.
Endpoints
GET/objects/{type}Read records
Needs a Reports key. Up to 500 records a page (
limit, 100 by default), oldest first, or newest first withorder=desc. SendnextCursorback ascursoruntil it'snull. Each record has itsid,createdAtand every field; links to other records are their ids, custom fields arecustom_<key>columns.Request
curl https://api.alori.dev/v1/objects/invoices?limit=100 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "data": [ { "id": "i97bc2d4e1", "createdAt": 1792580000000, "number": 2014, "customerId": "c12ab9f0e3", "status": "paid", "total": 189, "custom_region": "Laval" } ], "nextCursor": "eyJvIjoiYXNjIiwidCI6MTc5MjU4MDAwMDAwMCwiaSI6WyJpOTdiYzJkNGUxIl19" }GET/objects/{type}?{field}=Find records
Add any field and its value:
?email=ana@example.comreturns only the customers with that email, whichever of their addresses it is. Capital letters don't matter. For more than equals, writefield[op]=value:ne,gt,gte,lt,lte(numbers and dates, likecreatedAt[gte]=2026-01-01),contains, orexists(phone[exists]=false). Records must pass every filter. A page never holds more thanlimitrecords but can hold fewer, even none: keep sendingnextCursoruntil it'snullto be sure nothing was missed. A field the type doesn't have answersunknownFieldwith the ones you can use.Request
curl https://api.alori.dev/v1/objects/customers?email=marie@example.com \ -H "Authorization: Bearer YOUR_KEY"Response
{ "data": [ { "id": "c12ab9f0e3", "createdAt": 1792580000000, "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123", "status": "active" } ], "nextCursor": null }GET/objects/{type}/{id}Read one record
Needs a Reports key. Use the
ida list or an import gave you. A record that doesn't exist answers 404recordNotFound.Request
curl https://api.alori.dev/v1/objects/customers/c12ab9f0e3 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "data": { "id": "c12ab9f0e3", "createdAt": 1792580000000, "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123", "status": "active" } }GET/objectsList the record types and their fields
Read from your app's live schema, so fields and record types added to your app show up here. Your own record types come last, with
custom: true. The same list is under Fields below.Request
curl https://api.alori.dev/v1/objects \ -H "Authorization: Bearer YOUR_KEY"Response
{ "objects": [ { "type": "customers", "fields": [ { "name": "name", "type": "string", "required": true }, { "name": "status", "type": "enum", "required": false, "values": [ "lead", "active", "inactive" ] }, { "name": "companyId", "type": "reference", "required": false, "references": "companies" } ] }, { "type": "licenses", "custom": true, "fields": [ { "name": "plan", "type": "string", "required": true }, { "name": "seats", "type": "number", "required": true }, { "name": "customerId", "type": "reference", "required": false, "references": "customers" } ] } ] }POST/objects/{type}Create one record
Needs an Import key. Send the record's
fields, and anexternalIdif you want to find it again by your own id. The answer is the record with its Aloriid.Request
curl -X POST https://api.alori.dev/v1/objects/licenses \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "fields": { "plan": "Team", "seats": 12, "customerId": "c12ab9f0e3" } }'Response
{ "data": { "id": "k71fd0a3b2", "createdAt": 1792580000000, "plan": "Team", "seats": 12, "customerId": "c12ab9f0e3" }, "action": "created" }PATCH/objects/{type}/{id}Update one record
Needs an Import key. Only the
fieldsyou send change. A field set tonullis cleared. An id that doesn't exist answers 404recordNotFound.Request
curl -X PATCH https://api.alori.dev/v1/objects/licenses/k71fd0a3b2 \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "fields": { "seats": 15 } }'Response
{ "data": { "id": "k71fd0a3b2", "createdAt": 1792580000000, "plan": "Team", "seats": 15, "customerId": "c12ab9f0e3" }, "action": "updated" }POST/objects/{type}/batchCreate or update records
Up to 500 records of one type.
{type}is one of the record types below. Each record gets a result in the same order:created,updated,unchangedorfailed, with the reason.Request
curl -X POST https://api.alori.dev/v1/objects/jobs/batch \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "records": [ { "externalId": "job-2001", "fields": { "customerId": { "externalId": "cust-1001" }, "title": "Furnace tune-up", "scheduledAt": "2026-11-04T09:00:00-05:00", "price": "189,00 $" } } ], "dryRun": false }'Response
{ "runId": "k57a3f9q2xw8", "results": [ { "externalId": "job-2001", "id": "j97bc2d4e1", "action": "created", "errors": [] } ] }GET/importsList recent imports
Newest first, with how many records each one added, updated or failed.
Request
curl https://api.alori.dev/v1/imports \ -H "Authorization: Bearer YOUR_KEY"Response
{ "runs": [ { "id": "k57a3f9q2xw8", "source": "api", "status": "open", "created": 120, "updated": 4, "unchanged": 0, "failed": 1, "kept": 0, "createdAt": 1792580000000 } ] }GET/imports/{runId}Get one import
Check an import's counts and status.
Request
curl https://api.alori.dev/v1/imports/k57a3f9q2xw8 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "id": "k57a3f9q2xw8", "source": "api", "status": "open", "created": 120, "updated": 4, "unchanged": 0, "failed": 1, "kept": 0, "createdAt": 1792580000000 }DELETE/imports/{runId}Undo an import
Removes the records this import added. Records your team has added to since, like a job on an imported customer, are kept.
Request
curl -X DELETE https://api.alori.dev/v1/imports/k57a3f9q2xw8 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "deleted": 120, "kept": 3 }DELETE/objects/{type}/{id}Delete a record
An Import or Full access key. Works for customers, companies, contacts, deals, notes, jobs, quotes, invoices, projects and pipelines. Only that record goes: a deleted customer's deals, company and tasks stay. There is no undo.
Request
curl -X DELETE https://api.alori.dev/v1/objects/customers/c12ab9f0e3 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "ok": true }POST/messagesText or email a customer
Needs a Full access key.
channelissmsoremail(an email needs asubject;ccandsendAtare optional). It goes out right away from your business's number or address, shows on the customer's history, and customers who texted STOP get no text.Request
curl -X POST https://api.alori.dev/v1/messages \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "customerId": "c12ab9f0e3", "channel": "email", "subject": "Your booking is confirmed", "text": "Hi Marie, see you Tuesday at 10." }'Response
{ "ok": true, "channel": "email", "to": "Marie Tremblay", "sent": true }POST/customers/{id}/tagsTag a customer
Needs a Full access key.
addandremoveare lists of tag names; a tag that doesn't exist yet is made.Request
curl -X POST https://api.alori.dev/v1/customers/c12ab9f0e3/tags \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "add": [ "vip" ], "remove": [ "prospect" ] }'Response
{ "ok": true, "customers": [ "Marie Tremblay" ], "added": [ "vip" ], "removed": [ "prospect" ], "newTags": [] }POST/deals/{id}/stageMove a deal to a stage
Needs a Full access key.
stageis a stage key fromGET /objects/pipelines, won or lost included (lostReasonfor a lost one). UsepipelineIdto move it to another pipeline. A stage that requires fields answers which ones are missing.Request
curl -X POST https://api.alori.dev/v1/deals/d48fe1a2c7/stage \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "stage": "won" }'Response
{ "ok": true }GET/teamList your team
Needs a Full access key. Each person with their
userId(use it for owners and hosts), name, role and whether they're an admin.Request
curl https://api.alori.dev/v1/team \ -H "Authorization: Bearer YOUR_KEY"Response
{ "people": [ { "userId": "u82kd0c1sa", "name": "Julie Roy", "admin": true, "employee": true, "role": "Admin", "roleId": "px70c6k7vt" } ] }GET/bookingsList bookings
Needs a Full access key. Requests
waitingfor an answer, appointmentsupcoming, and your booking links (types), whose_idis thebookingLinkIdto book with.Request
curl https://api.alori.dev/v1/bookings \ -H "Authorization: Bearer YOUR_KEY"Response
{ "waiting": [], "upcoming": [ { "_id": "wh7aktvtbn", "customer": "Marie Tremblay", "email": "marie@example.com", "type": "Discovery call", "host": "Julie Roy", "at": "Tue, Nov 10, 10:00 a.m.", "status": "confirmed" } ], "types": [ { "_id": "wd74sd5z41", "name": "Discovery call", "minutes": 30, "active": true, "locations": [ "video" ] } ] }POST/bookingsBook an appointment
Needs a Full access key.
bookingLinkId,start(ISO text or milliseconds), the customer'snameandemail, andphoneif you have it. The customer gets the confirmation email. A taken time is refused unless you sendignoreAvailability: true. Answers thebookingId.Request
curl -X POST https://api.alori.dev/v1/bookings \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "bookingLinkId": "wd74sd5z41", "start": "2026-11-10T10:00:00-05:00", "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123" }'Response
{ "ok": true, "sent": true, "bookingId": "wh7aktvtbn" }POST/bookings/{id}/moveMove a booking
Needs a Full access key. A new
start; the customer and your team are emailed the new time.Request
curl -X POST https://api.alori.dev/v1/bookings/wh7aktvtbn/move \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "start": "2026-11-11T14:00:00-05:00" }'Response
{ "ok": true, "sent": true }POST/bookings/{id}/cancelCancel, confirm or decline a booking
Needs a Full access key.
/cancelcancels an appointment,/confirmand/declineanswer a request.reasonis optional and goes in the customer's email.Request
curl -X POST https://api.alori.dev/v1/bookings/wh7aktvtbn/cancel \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "reason": "Marie asked to cancel." }'Response
{ "ok": true, "sent": true }GET/eventsList calendar events
Needs a Full access key. Your team's events and your Google Calendar or Outlook ones, between
fromandto(ISO dates or milliseconds; the next two weeks without them).Request
curl https://api.alori.dev/v1/events?from=2026-11-09&to=2026-11-16 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "events": [ { "eventId": "gbsv8n7qep", "calendarId": "julie@example.com", "source": "google", "title": "Blocked: day off", "start": 1794600000000, "end": 1794628800000, "guests": [] } ] }POST/eventsBlock time on the calendar
Needs a Full access key.
title,startanddurationMinutes(60 by default). The time shows as busy, so nobody can book it.guests(emails) are invited. Answers theeventId, and thecalendarIdwhen it went to Google Calendar or Outlook.Request
curl -X POST https://api.alori.dev/v1/events \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Blocked: day off", "start": "2026-11-12T09:00:00-05:00", "durationMinutes": 480 }'Response
{ "ok": true, "eventId": "gbsv8n7qep", "calendarId": "julie@example.com" }PATCH/events/{id}Change an event
Needs a Full access key. Only what you send changes:
title,start,durationMinutes,guests,location. Send thecalendarIdyou got for a Google Calendar or Outlook event.Request
curl -X PATCH https://api.alori.dev/v1/events/gbsv8n7qep \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "calendarId": "julie@example.com", "start": "2026-11-13T09:00:00-05:00" }'Response
{ "ok": true, "eventId": "gbsv8n7qep" }DELETE/events/{id}Remove an event
Needs a Full access key. Add
?calendarId=for a Google Calendar or Outlook event. A booked appointment is cancelled from its booking instead.Request
curl -X DELETE https://api.alori.dev/v1/events/gbsv8n7qep?calendarId=julie@example.com \ -H "Authorization: Bearer YOUR_KEY"Response
{ "ok": true }GET/chat/channelsList Team chat channels
Needs a Full access key. The channels and direct messages of the key's person, most recent first, each with its
channelId,kindand unread count.browse=trueadds public channels they haven't joined.Request
curl https://api.alori.dev/v1/chat/channels \ -H "Authorization: Bearer YOUR_KEY"Response
{ "channels": [ { "channelId": "j97def4a21", "name": "leads", "kind": "public", "unread": 3 }, { "channelId": "j31bb8c0e9", "name": "Alex Martin", "kind": "dm", "unread": 0 } ] }GET/chat/channels/{channel}/messagesRead a Team chat channel's messages
Needs a Full access key.
{channel}is achannelId, a channel's name or a teammate's name for your DMs with them. The last messages, oldest first, with theirmessageId, author, time, replies and buttons.threadIdreads a thread instead.Request
curl https://api.alori.dev/v1/chat/channels/leads/messages?limit=30 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "channelId": "j97def4a21", "name": "leads", "kind": "public", "people": [ "Alex Martin", "Nic Roy" ], "messages": [ { "messageId": "m12ab3c4d5", "author": "Nic Roy", "at": "2026-11-16T14:05:00.000Z", "text": "Jane Doe called back, she's in.", "replies": 2 } ] }POST/chat/messagesPost a message in a Team chat channel
Needs a Full access key. With
textonly, it posts as the key's person in achannel(id or name), to a teammate (channel: their name) or to several (people);threadIdreplies in a thread,mentionnotifies teammates,linksadds up to 5 link buttons. Withblocks(Slack's Block Kit), it posts in a channel as an app named after your key, with buttons, menus and pickers.interaction_url(https) gets each click as Slack'sblock_actions, signedX-Alori-Signature: v0=HMAC-SHA256(key, "v0:<X-Alori-Request-Timestamp>:<body>"), where the key is the SHA-256 hex of your API key. Answer within 3 seconds, or later through the click'sresponse_url, withreplace_originalto mark the lead claimed.Want custom buttons, menus or forms in your Team chat messages, like a Claim lead button? Read how buttons work →
Request
curl -X POST https://api.alori.dev/v1/chat/messages \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "channel": "leads", "text": "New lead: Jane Doe, Doe Rénovations", "interaction_url": "https://example.com/alori/clicks", "blocks": [ { "type": "section", "text": { "type": "mrkdwn", "text": "New lead from Meta ads: *Jane Doe*" } }, { "type": "section", "fields": [ { "type": "mrkdwn", "text": "*Phone*\n+1 514 555 0199" }, { "type": "mrkdwn", "text": "*Email*\njane.doe@example.com" }, { "type": "mrkdwn", "text": "*Company*\nDoe Rénovations" } ] }, { "type": "actions", "block_id": "lead", "elements": [ { "type": "button", "action_id": "claim", "text": { "type": "plain_text", "text": "Claim lead" }, "style": "primary", "value": "lead_8812" }, { "type": "button", "action_id": "open", "text": { "type": "plain_text", "text": "Open deal" }, "url": "https://example.com/leads/8812" } ] } ] }'Response
{ "ok": true, "messageId": "m12ghi7k3p", "channelId": "j97def4a21" }GET/targetsList your target lists
Needs a Full access key. Lists of people, and their companies, who don't know you yet. Each with its
_id, how many people and companies it holds, and how many are new, in a sequence, replied, in the pipeline or customers.Request
curl https://api.alori.dev/v1/targets \ -H "Authorization: Bearer YOUR_KEY"Response
{ "lists": [ { "_id": "k57ab1target", "name": "SaaS founders · Montreal", "from": "companies", "people": 42, "companies": 30, "byStatus": { "new": 30, "sequence": 10, "replied": 2 }, "sequencesFollowing": 1 } ] }POST/targetsMake a target list
Needs a Full access key. A
name(optional). Answers itslistId; then add rows to it.Request
curl -X POST https://api.alori.dev/v1/targets \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "SaaS founders · Montreal" }'Response
{ "ok": true, "listId": "k57ab1target", "name": "SaaS founders · Montreal" }GET/targets/{id}/rowsRead a target list
Needs a Full access key. 100 rows a page, newest first; send
cursorback whilemoreis true.statuskeeps people standing there (new: never written to). A company with nobody yet comes withnobodyYet: true.Request
curl https://api.alori.dev/v1/targets/k57ab1target/rows?status=new \ -H "Authorization: Bearer YOUR_KEY"Response
{ "people": [ { "memberId": "m12cd3row1", "customerId": "c12ab9f0e3", "name": "Marie Tremblay", "email": "marie@northpixel.io", "title": "CEO", "companyId": "co4f1a2b3c", "company": "Northpixel", "domain": "northpixel.io", "status": "new" }, { "memberId": "m12cd3row2", "companyId": "co8e7d6c5b", "company": "Rablab", "domain": "rablab.com", "nobodyYet": true } ], "more": false }POST/targets/{id}/rowsAdd people or companies to a target list
Needs a Full access key.
companies(each with itsdomain, the website, and aname),people(each with anemailor aphone, andname,title,company,domain) orcustomerIds: up to 1,000 of each per request. Someone already in your CRM is matched by email, then phone, and a company by its website, never added twice. Answers how many wereadded,alreadyon it orskipped.Request
curl -X POST https://api.alori.dev/v1/targets/k57ab1target/rows \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "companies": [ { "name": "Rablab", "domain": "rablab.com" } ], "people": [ { "email": "marie@northpixel.io", "name": "Marie Tremblay", "title": "CEO", "domain": "northpixel.io" } ] }'Response
{ "ok": true, "listId": "k57ab1target", "added": 2, "already": 0, "skipped": 0, "summary": "2 added to \"SaaS founders · Montreal\"." }GET/webhooksList your webhooks
Needs a Full access key. Each one with its address, its events, whether it's on and its last error.
Request
curl https://api.alori.dev/v1/webhooks \ -H "Authorization: Bearer YOUR_KEY"Response
{ "webhooks": [ { "id": "n98bhwf811", "url": "https://example.com/alori-webhook", "events": [ "customer.created", "customer.updated" ], "createdAt": 1792580000000, "on": true, "lastDeliveredAt": 1792583600000 } ] }POST/webhooksAdd a webhook
Needs a Full access key.
urlmust be https.events: any ofcustomer.created,customer.updated,customer.deleted,deal.created,deal.updated,deal.deleted,company.created,company.updated,company.deleted,contact.created,contact.updated,contact.deleted,task.created,task.updated,task.deleted,booking.created,booking.updated,booking.cancelled,booking.deleted,note.created,message.received,ticket.created,ticket.updated,ticket.deleted,ticket.commented,record.created,record.updated,record.deleted. The answer has the signingsecret, shown only this once. Up to 10 per app.Request
curl -X POST https://api.alori.dev/v1/webhooks \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com/alori-webhook", "events": [ "customer.created", "customer.updated", "booking.created" ] }'Response
{ "id": "n98bhwf811", "secret": "whsec_31da004ce6a9d4a8f9a36caefd3333448db7378dfa12ee58" }POST/webhooks/{id}/testSend a test event
Sends a
testevent within seconds, so you can check your receiver and its signature check.Request
curl -X POST https://api.alori.dev/v1/webhooks/n98bhwf811/test \ -H "Authorization: Bearer YOUR_KEY"Response
{ "ok": true }DELETE/webhooks/{id}Remove a webhook
It stops right away, and what was waiting to be sent to it is dropped.
Request
curl -X DELETE https://api.alori.dev/v1/webhooks/n98bhwf811 \ -H "Authorization: Bearer YOUR_KEY"Response
{ "ok": true }
Webhooks
Alori sends a POST to your address each time something you picked changes, whatever made the change: your team, Ask Sam, an import or this API. Add them above or with POST /webhooks.
- What arrives
event,occurredAt,recordId,data(the record asGET /objectsreads it, or as it was before a delete),changedFieldson an update, andexternalIdwhen you imported the record with your own id.- Signed
- Each one has an
Alori-Signature: t=…,v1=…header: the HMAC-SHA256 of<t>.<raw body>with your secret. Check it before trusting the body, and refuse atolder than 5 minutes. - Retries
- Answer with a 2xx within 10 seconds. Otherwise Alori tries again after 1 minute, 5 minutes, 30 minutes, then 2, 6 and 12 hours. After 20 failures in a row the webhook pauses, and this page shows why.
- Once each
idstays the same on every retry: keep the ones you've handled and skip a repeat. Changes arrive within about a minute.
What your address receives
{
"id": "evt_c12ab9f0e3_1792580000000_customer_updated",
"event": "customer.updated",
"occurredAt": "2026-10-20T14:13:20.000Z",
"recordId": "c12ab9f0e3",
"externalId": "cust-1001",
"changedFields": [
"phone"
],
"data": {
"id": "c12ab9f0e3",
"createdAt": 1792580000000,
"name": "Marie Tremblay",
"email": "marie@example.com",
"phone": "514-555-0199",
"status": "active"
}
}Check the signature
# Alori-Signature: t=1792580000,v1=5f0c…
# Sign "<t>.<raw body>" with your secret and compare with v1:
printf '%s.%s' "$T" "$BODY" | openssl dgst -sha256 -hmac "$ALORI_WEBHOOK_SECRET"Fields in your app
Each app has its own fields and record types, because you can add your own in Build mode, and the API takes them all. GET /v1/objects lists yours.
Changed your app?
If you added record types or fields in Build mode, or changed your app in any other way, your docs differ from this page. They list every type and field your app has, with examples.
Sign in to see your docs →Errors
Errors come back as { "error": { "code": "…", "message": "…" } }. A bad record in a batch doesn't fail the request: it gets failed and its errors.
| Status | Meaning |
|---|---|
| 400 | The body isn't valid JSON or misses records, or the query is wrong: a bad limit, order or cursor, a filter without a value, or a field the type doesn't have (unknownField). |
| 401 | The key is missing, wrong or revoked. |
| 403 | The key can't do this: a Reports key only reads, an Import key only imports, and only a Full access key runs actions and manages webhooks. |
| 404 | Unknown record type, import or webhook, an id that names nothing, or a module your app doesn't have (scheduling for bookings and events). |
| 409 | Your app isn't ready for the API yet, or the import is already undone. |
| 413 | More than 500 records in one request. |
| 422 | A record is malformed, two share an externalId, or Alori refused an action: details says why (a stage that needs fields, a time already taken…). |
| 429 | Too many requests. Wait a minute and try again. |
| 502 | The action was ready but the text or email couldn't go out (notSent). Try again. |
OpenAPI file · For tools like Postman, or to give an AI agent.