Développeurs
API d'Alori
Lis et importe tes fiches, envoie des textos et des courriels, réserve des rencontres et sois averti des changements par webhook. Les types de fiches ajoutés à ton app marchent aussi. La doc de ton app les liste avec leurs champs.
Tu as modifié ton app ?
Si tu as ajouté des types de fiches ou des champs en mode Création, ou modifié ton app autrement, ta doc diffère de cette page. Elle liste chaque type et champ de ton app, avec des exemples.
Connecte-toi pour voir ta doc →Pour commencer
- 1
Crée une clé. Dans Alori, ouvre Connecteurs, puis API, et clique sur Nouvelle clé. Copie-la : elle n'est affichée qu'une fois.
- 2
Envoie un client. Lance cette requête avec ta clé. Elle ajoute Marie Tremblay à ton 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
Vois-le dans ton CRM. Elle apparaît tout de suite dans Clients. Sous Importations récentes dans Connecteurs → API, tu peux annuler toute l'importation.
Comment ça marche
- Tes identifiants
- Donne à chaque fiche un
externalId: son identifiant dans ton ancien outil. Renvoie le même et Alori met la fiche à jour au lieu d'en faire une copie : un nouvel essai est donc toujours sans risque. - Relier des fiches
- Pointe vers une autre fiche avec
{ "externalId": "…" }(une fiche importée),{ "id": "…" }(une fiche déjà dans Alori) ou{ "email": "…" }(un client, ou un coéquipier pour les champs commeownerId). - Ordre
- Envoie les parents avant les fiches qui pointent vers eux : champs personnalisés, entreprises, clients, contacts, pipelines, affaires, articles, soumissions, travaux, factures, notes, communications, puis tâches.
- Valeurs
- Les montants et les nombres peuvent être du texte (
"1 650,00 $"). Les dates sont du texte ISO ("2026-03-04"ou"2026-03-04T09:30:00-05:00"). Mets un champ ànullpour le vider. Les champs personnalisés vont danscustom. - Correspondance
- Une fiche jamais envoyée est jumelée à une fiche déjà dans Alori : un client par courriel ou téléphone, une entreprise par domaine ou nom, un article par nom, une soumission ou une facture par numéro. Envoie
"match": "externalId"pour toujours en créer une nouvelle. - Teste d'abord
- Ajoute
"dryRun": truepour vérifier chaque fiche sans rien enregistrer. La réponse liste les problèmes, champ par champ. - Importations et annulation
- Chaque requête est une importation que tu peux annuler. Pour regrouper plusieurs requêtes en une importation, renvoie le
runIdreçu dans un en-têteX-Alori-Run. L'annulation retire ce que l'importation a ajouté et garde les fiches que ton équipe a complétées depuis. - Clés
- Une clé Rapports lit, une clé Importation importe. Une clé Accès complet fait les deux, et envoie aussi des textos et des courriels, étiquette, déplace des affaires, réserve et bloque du temps, et gère les webhooks : c'est celle de ton propre logiciel.
- Tes propres fiches
- Les types de fiches ajoutés à ton app en mode Création marchent comme ceux d'origine : lire, créer, modifier, supprimer et webhooks.
GET /v1/objectsles liste aveccustom: true, sous le nom de leur table. - Limites
- Jusqu'à 500 fiches par requête et 120 requêtes par minute par clé.
Points d'accès
GET/objects/{type}Lire des fiches
Demande une clé Rapports. Jusqu'à 500 fiches par page (
limit, 100 par défaut), des plus anciennes aux plus récentes, ou l'inverse avecorder=desc. RenvoienextCursorcommecursorjusqu'à ce qu'il soitnull. Chaque fiche a sonid, soncreatedAtet tous ses champs; les liens vers d'autres fiches sont leurs ids, les champs personnalisés sont des colonnescustom_<clé>.Requête
curl https://api.alori.dev/v1/objects/invoices?limit=100 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "data": [ { "id": "i97bc2d4e1", "createdAt": 1792580000000, "number": 2014, "customerId": "c12ab9f0e3", "status": "paid", "total": 189, "custom_region": "Laval" } ], "nextCursor": "eyJvIjoiYXNjIiwidCI6MTc5MjU4MDAwMDAwMCwiaSI6WyJpOTdiYzJkNGUxIl19" }GET/objects/{type}?{field}=Trouver des fiches
Ajoute un champ et sa valeur :
?email=ana@exemple.comdonne seulement les clients avec ce courriel, peu importe lequel de leurs courriels c'est. Les majuscules ne comptent pas. Pour plus qu'une égalité, écrischamp[op]=valeur:ne,gt,gte,lt,lte(nombres et dates, commecreatedAt[gte]=2026-01-01),containsouexists(phone[exists]=false). Les fiches doivent passer tous les filtres. Une page ne dépasse jamaislimitfiches mais peut en avoir moins, même aucune : renvoienextCursorjusqu'à ce qu'il soitnullpour ne rien manquer. Un champ que le type n'a pas répondunknownFieldavec ceux que tu peux utiliser.Requête
curl https://api.alori.dev/v1/objects/customers?email=marie@example.com \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "data": [ { "id": "c12ab9f0e3", "createdAt": 1792580000000, "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123", "status": "active" } ], "nextCursor": null }GET/objects/{type}/{id}Lire une fiche
Demande une clé Rapports. Utilise l'
idqu'une liste ou une importation t'a donné. Une fiche qui n'existe pas répond 404recordNotFound.Requête
curl https://api.alori.dev/v1/objects/customers/c12ab9f0e3 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "data": { "id": "c12ab9f0e3", "createdAt": 1792580000000, "name": "Marie Tremblay", "email": "marie@example.com", "phone": "514-555-0123", "status": "active" } }GET/objectsLister les types de fiches et leurs champs
Lu dans le schéma en direct de ton app : les champs et les types de fiches ajoutés à ton app y apparaissent. Tes propres types viennent à la fin, avec
custom: true. La même liste est sous Champs plus bas.Requête
curl https://api.alori.dev/v1/objects \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "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}Créer une fiche
Demande une clé Importation. Envoie les
fieldsde la fiche, et unexternalIdsi tu veux la retrouver par ton propre id. La réponse est la fiche avec sonidAlori.Requête
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" } }'Réponse
{ "data": { "id": "k71fd0a3b2", "createdAt": 1792580000000, "plan": "Team", "seats": 12, "customerId": "c12ab9f0e3" }, "action": "created" }PATCH/objects/{type}/{id}Modifier une fiche
Demande une clé Importation. Seuls les
fieldsenvoyés changent. Un champ ànullest vidé. Un id qui n'existe pas répond 404recordNotFound.Requête
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 } }'Réponse
{ "data": { "id": "k71fd0a3b2", "createdAt": 1792580000000, "plan": "Team", "seats": 15, "customerId": "c12ab9f0e3" }, "action": "updated" }POST/objects/{type}/batchCréer ou mettre à jour des fiches
Jusqu'à 500 fiches d'un même type.
{type}est l'un des types de fiches plus bas. Chaque fiche reçoit un résultat dans le même ordre :created,updated,unchangedoufailed, avec la raison.Requête
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 }'Réponse
{ "runId": "k57a3f9q2xw8", "results": [ { "externalId": "job-2001", "id": "j97bc2d4e1", "action": "created", "errors": [] } ] }GET/importsLister les importations récentes
Les plus récentes d'abord, avec le nombre de fiches ajoutées, mises à jour ou en échec.
Requête
curl https://api.alori.dev/v1/imports \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "runs": [ { "id": "k57a3f9q2xw8", "source": "api", "status": "open", "created": 120, "updated": 4, "unchanged": 0, "failed": 1, "kept": 0, "createdAt": 1792580000000 } ] }GET/imports/{runId}Voir une importation
Vérifie les nombres et l'état d'une importation.
Requête
curl https://api.alori.dev/v1/imports/k57a3f9q2xw8 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "id": "k57a3f9q2xw8", "source": "api", "status": "open", "created": 120, "updated": 4, "unchanged": 0, "failed": 1, "kept": 0, "createdAt": 1792580000000 }DELETE/imports/{runId}Annuler une importation
Retire les fiches que cette importation a ajoutées. Les fiches que ton équipe a complétées depuis, comme un travail sur un client importé, sont gardées.
Requête
curl -X DELETE https://api.alori.dev/v1/imports/k57a3f9q2xw8 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "deleted": 120, "kept": 3 }DELETE/objects/{type}/{id}Supprimer une fiche
Une clé Importation ou Accès complet. Pour les clients, entreprises, contacts, affaires, notes, travaux, soumissions, factures, projets et pipelines. Seule cette fiche part : les affaires, l'entreprise et les tâches d'un client supprimé restent. Pas d'annulation possible.
Requête
curl -X DELETE https://api.alori.dev/v1/objects/customers/c12ab9f0e3 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "ok": true }POST/messagesTexter ou écrire à un client
Demande une clé Accès complet.
channelvautsmsouemail(un courriel demande unsubject;ccetsendAtsont optionnels). Le message part tout de suite du numéro ou de l'adresse de ton entreprise, paraît dans l'historique du client, et ceux qui ont texté STOP ne reçoivent pas de texto.Requête
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." }'Réponse
{ "ok": true, "channel": "email", "to": "Marie Tremblay", "sent": true }POST/customers/{id}/tagsÉtiqueter un client
Demande une clé Accès complet.
addetremovesont des listes de noms d'étiquettes; une étiquette qui n'existe pas encore est créée.Requête
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" ] }'Réponse
{ "ok": true, "customers": [ "Marie Tremblay" ], "added": [ "vip" ], "removed": [ "prospect" ], "newTags": [] }POST/deals/{id}/stageDéplacer une affaire vers une étape
Demande une clé Accès complet.
stageest une clé d'étape tirée deGET /objects/pipelines, gagnée ou perdue incluse (lostReasonpour une perdue).pipelineIdla déplace vers un autre pipeline. Une étape qui exige des champs répond lesquels manquent.Requête
curl -X POST https://api.alori.dev/v1/deals/d48fe1a2c7/stage \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "stage": "won" }'Réponse
{ "ok": true }GET/teamLister ton équipe
Demande une clé Accès complet. Chaque personne avec son
userId(pour les responsables et les hôtes), son nom, son rôle et si elle est admin.Requête
curl https://api.alori.dev/v1/team \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "people": [ { "userId": "u82kd0c1sa", "name": "Julie Roy", "admin": true, "employee": true, "role": "Admin", "roleId": "px70c6k7vt" } ] }GET/bookingsLister les réservations
Demande une clé Accès complet. Les demandes en attente (
waiting), les rendez-vous à venir (upcoming) et tes liens de réservation (types), dont l'_idest lebookingLinkIdpour réserver.Requête
curl https://api.alori.dev/v1/bookings \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "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/bookingsRéserver un rendez-vous
Demande une clé Accès complet.
bookingLinkId,start(texte ISO ou millisecondes), lenameet l'emaildu client, et sonphonesi tu l'as. Le client reçoit le courriel de confirmation. Une plage prise est refusée, sauf avecignoreAvailability: true. Répond lebookingId.Requête
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" }'Réponse
{ "ok": true, "sent": true, "bookingId": "wh7aktvtbn" }POST/bookings/{id}/moveDéplacer une réservation
Demande une clé Accès complet. Un nouveau
start; le client et ton équipe reçoivent la nouvelle heure par courriel.Requête
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" }'Réponse
{ "ok": true, "sent": true }POST/bookings/{id}/cancelAnnuler, confirmer ou refuser une réservation
Demande une clé Accès complet.
/cancelannule un rendez-vous,/confirmet/declinerépondent à une demande.reasonest optionnel et va dans le courriel du client.Requête
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." }'Réponse
{ "ok": true, "sent": true }GET/eventsLister les événements du calendrier
Demande une clé Accès complet. Les événements de ton équipe et ceux de Google Agenda ou Outlook, entre
frometto(dates ISO ou millisecondes; les deux prochaines semaines sans eux).Requête
curl https://api.alori.dev/v1/events?from=2026-11-09&to=2026-11-16 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "events": [ { "eventId": "gbsv8n7qep", "calendarId": "julie@example.com", "source": "google", "title": "Blocked: day off", "start": 1794600000000, "end": 1794628800000, "guests": [] } ] }POST/eventsBloquer du temps au calendrier
Demande une clé Accès complet.
title,startetdurationMinutes(60 par défaut). La plage paraît occupée, donc personne ne peut la réserver. Lesguests(courriels) sont invités. Répond l'eventId, et lecalendarIdquand l'événement est allé dans Google Agenda ou Outlook.Requête
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 }'Réponse
{ "ok": true, "eventId": "gbsv8n7qep", "calendarId": "julie@example.com" }PATCH/events/{id}Modifier un événement
Demande une clé Accès complet. Seul ce que tu envoies change :
title,start,durationMinutes,guests,location. Envoie lecalendarIdreçu pour un événement Google Agenda ou Outlook.Requête
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" }'Réponse
{ "ok": true, "eventId": "gbsv8n7qep" }DELETE/events/{id}Retirer un événement
Demande une clé Accès complet. Ajoute
?calendarId=pour un événement Google Agenda ou Outlook. Un rendez-vous réservé s'annule plutôt depuis sa réservation.Requête
curl -X DELETE https://api.alori.dev/v1/events/gbsv8n7qep?calendarId=julie@example.com \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "ok": true }GET/chat/channelsLister les canaux du Team chat
Demande une clé Accès complet. Les canaux et messages directs de la personne de la clé, les plus récents d'abord, chacun avec son
channelId, sonkindet ses non-lus.browse=trueajoute les canaux publics qu'elle n'a pas rejoints.Requête
curl https://api.alori.dev/v1/chat/channels \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "channels": [ { "channelId": "j97def4a21", "name": "leads", "kind": "public", "unread": 3 }, { "channelId": "j31bb8c0e9", "name": "Alex Martin", "kind": "dm", "unread": 0 } ] }GET/chat/channels/{channel}/messagesLire les messages d'un canal du Team chat
Demande une clé Accès complet.
{channel}est unchannelId, le nom d'un canal ou le nom d'un coéquipier pour tes messages directs avec lui. Les derniers messages, les plus anciens d'abord, avec leurmessageId, l'auteur, l'heure, les réponses et les boutons.threadIdlit un fil à la place.Requête
curl https://api.alori.dev/v1/chat/channels/leads/messages?limit=30 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "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/messagesPublier un message dans un canal du Team chat
Demande une clé Accès complet. Avec
textseul, écrit au nom de la personne de la clé dans unchannel(identifiant ou nom), à un coéquipier (channel: son nom) ou à plusieurs (people);threadIdrépond dans un fil,mentionavertit des coéquipiers,linksajoute jusqu'à 5 boutons-liens. Avecblocks(le Block Kit de Slack), publie dans un canal au nom d'une app qui porte le nom de ta clé, avec des boutons, des menus et des sélecteurs.interaction_url(https) reçoit chaque clic comme leblock_actionsde Slack, signéX-Alori-Signature: v0=HMAC-SHA256(clé, "v0:<X-Alori-Request-Timestamp>:<corps>"), où la clé est le SHA-256 en hexadécimal de ta clé d'API. Réponds en moins de 3 secondes, ou plus tard par leresponse_urldu clic, avecreplace_originalpour marquer le lead comme pris.Tu veux des boutons, des menus ou des formulaires sur mesure dans tes messages du Team chat, comme un bouton Prendre le lead? Lis comment marchent les boutons →
Requête
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" } ] } ] }'Réponse
{ "ok": true, "messageId": "m12ghi7k3p", "channelId": "j97def4a21" }GET/targetsLister tes listes de cibles
Demande une clé Accès complet. Les listes de personnes, et de leurs entreprises, qui ne te connaissent pas encore. Chacune avec son
_id, son nombre de personnes et d'entreprises, et combien sont nouvelles, dans une séquence, ont répondu, sont dans le pipeline ou clientes.Requête
curl https://api.alori.dev/v1/targets \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "lists": [ { "_id": "k57ab1target", "name": "SaaS founders · Montreal", "from": "companies", "people": 42, "companies": 30, "byStatus": { "new": 30, "sequence": 10, "replied": 2 }, "sequencesFollowing": 1 } ] }POST/targetsCréer une liste de cibles
Demande une clé Accès complet. Un
name(facultatif). Répond sonlistId; ajoutes-y ensuite des lignes.Requête
curl -X POST https://api.alori.dev/v1/targets \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "SaaS founders · Montreal" }'Réponse
{ "ok": true, "listId": "k57ab1target", "name": "SaaS founders · Montreal" }GET/targets/{id}/rowsLire une liste de cibles
Demande une clé Accès complet. 100 lignes par page, les plus récentes d'abord ; renvoie
cursortant quemoreest vrai.statusgarde les personnes à cette étape (new: jamais contactées). Une entreprise où personne n'a encore été trouvé vient avecnobodyYet: true.Requête
curl https://api.alori.dev/v1/targets/k57ab1target/rows?status=new \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "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}/rowsAjouter des personnes ou des entreprises à une liste de cibles
Demande une clé Accès complet.
companies(chacune avec sondomain, le site web, et unname),people(chacune avec unemailou unphone, etname,title,company,domain) oucustomerIds: jusqu'à 1 000 de chaque par requête. Une personne déjà dans ton CRM est retrouvée par courriel, puis par téléphone, et une entreprise par son site web, jamais ajoutée deux fois. Répond combien ont été ajoutées (added), y étaient déjà (already) ou ont été ignorées (skipped).Requête
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" } ] }'Réponse
{ "ok": true, "listId": "k57ab1target", "added": 2, "already": 0, "skipped": 0, "summary": "2 added to \"SaaS founders · Montreal\"." }GET/webhooksLister tes webhooks
Demande une clé Accès complet. Chacun avec son adresse, ses événements, s'il est actif et sa dernière erreur.
Requête
curl https://api.alori.dev/v1/webhooks \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "webhooks": [ { "id": "n98bhwf811", "url": "https://example.com/alori-webhook", "events": [ "customer.created", "customer.updated" ], "createdAt": 1792580000000, "on": true, "lastDeliveredAt": 1792583600000 } ] }POST/webhooksAjouter un webhook
Demande une clé Accès complet.
urldoit être en https.events: parmicustomer.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. La réponse contient lesecretde signature, affiché cette seule fois. Jusqu'à 10 par app.Requête
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" ] }'Réponse
{ "id": "n98bhwf811", "secret": "whsec_31da004ce6a9d4a8f9a36caefd3333448db7378dfa12ee58" }POST/webhooks/{id}/testEnvoyer un événement test
Envoie un événement
testen quelques secondes, pour vérifier ton récepteur et sa vérification de signature.Requête
curl -X POST https://api.alori.dev/v1/webhooks/n98bhwf811/test \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "ok": true }DELETE/webhooks/{id}Retirer un webhook
Il s'arrête tout de suite, et ce qui attendait d'être envoyé est abandonné.
Requête
curl -X DELETE https://api.alori.dev/v1/webhooks/n98bhwf811 \ -H "Authorization: Bearer YOUR_KEY"Réponse
{ "ok": true }
Webhooks
Alori envoie un POST à ton adresse chaque fois que quelque chose que tu as choisi change, peu importe d'où vient le changement : ton équipe, Demande à Sam, une importation ou cette API. Ajoute-les plus haut ou avec POST /webhooks.
- Ce qui arrive
event,occurredAt,recordId,data(la fiche commeGET /objectsla lit, ou telle qu'elle était avant une suppression),changedFieldspour une modification, etexternalIdquand tu as importé la fiche avec ton propre identifiant.- Signé
- Chacun a un en-tête
Alori-Signature: t=…,v1=…: le HMAC-SHA256 de<t>.<corps brut>avec ton secret. Vérifie-le avant de te fier au corps, et refuse untde plus de 5 minutes. - Nouvelles tentatives
- Réponds par un 2xx en moins de 10 secondes. Sinon, Alori réessaie après 1 minute, 5 minutes, 30 minutes, puis 2, 6 et 12 heures. Après 20 échecs de suite, le webhook se met en pause et cette page dit pourquoi.
- Une seule fois
idreste le même à chaque tentative : garde ceux que tu as traités et ignore un doublon. Les changements arrivent en environ une minute.
Ce que ton adresse reçoit
{
"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"
}
}Vérifier la 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"Champs de ton app
Chaque app a ses propres champs et types de fiches, puisque tu peux en ajouter en mode Création, et l'API les prend tous. GET /v1/objects liste les tiens.
Tu as modifié ton app ?
Si tu as ajouté des types de fiches ou des champs en mode Création, ou modifié ton app autrement, ta doc diffère de cette page. Elle liste chaque type et champ de ton app, avec des exemples.
Connecte-toi pour voir ta doc →Erreurs
Les erreurs reviennent sous la forme { "error": { "code": "…", "message": "…" } }. Une fiche invalide dans un lot ne fait pas échouer la requête : elle reçoit failed et ses errors.
| Statut | Signification |
|---|---|
| 400 | Le corps n'est pas du JSON valide ou il manque records, ou la requête est invalide : limit, order ou cursor incorrect, un filtre sans valeur, ou un champ que le type n'a pas (unknownField). |
| 401 | La clé est absente, erronée ou révoquée. |
| 403 | La clé ne peut pas faire ça : une clé Rapports ne fait que lire, une clé Importation ne fait qu'importer, et seule une clé Accès complet lance des actions et gère les webhooks. |
| 404 | Type de fiche, importation ou webhook inconnu, un identifiant qui ne correspond à rien, ou un module que ton app n'a pas (le calendrier pour les réservations et les événements). |
| 409 | Ton app n'est pas encore prête pour l'API, ou l'importation est déjà annulée. |
| 413 | Plus de 500 fiches dans une requête. |
| 422 | Une fiche est mal formée, deux partagent un externalId, ou Alori a refusé une action : details dit pourquoi (une étape qui exige des champs, une plage déjà prise…). |
| 429 | Trop de requêtes. Attends une minute et réessaie. |
| 502 | L'action était prête, mais le texto ou le courriel n'a pas pu partir (notSent). Réessaie. |
Fichier OpenAPI · Pour des outils comme Postman, ou à donner à un agent d'IA.