Les evenements suivent la convention de nommage entite.action. Allo livre les evenements au moins une fois -- votre endpoint peut recevoir le meme evenement plusieurs fois. Utilisez l'en-tete webhook-id pour dedupliquer. Voir Bonnes pratiques pour plus de details.
Resume des evenements
| Evenement | Description |
|---|---|
call.received | Un appel entrant commence a sonner |
call.triggered | Un appel sortant est initie |
call.answered | Un appel est decroche de l'autre cote |
call.completed | Un appel est termine avec toutes les donnees |
tag.added | Un tag est ajoute a un appel |
tag.removed | Un tag est supprime d'un appel |
sms.received | Un SMS entrant est recu |
sms.sent | Un SMS sortant est envoye |
contact.created | Un contact est cree |
contact.updated | Un contact est mis a jour |
summary.updated | Le résumé d'un appel a été modifié |
conversation_note.created | Une note interne est ajoutée à une conversation |
conversation_note.updated | Une note de conversation est modifiée |
conversation_note.deleted | Une note de conversation est supprimée |
contact_note.created | Une note est ajoutée au profil CRM d'une personne |
contact_note.updated | Une note de personne est modifiée |
contact_note.deleted | Une note de personne est supprimée |
thread.created | Un fil de discussion est démarré sur un élément de conversation |
thread.comment.created | Un commentaire est ajouté à un fil |
thread.comment.updated | Un commentaire de fil est modifié |
thread.resolved | Un fil est marqué comme résolu |
thread.unresolved | Un fil est rouvert |
teammate_message.created | Un coéquipier a envoyé un message direct à un autre coéquipier |
Événements partenaire
Les événements partenaire sont livrés au endpoint webhook du partenaire, pas à celui du compte.
| Événement | Description |
|---|---|
partner.account.login | Un compte provisionné par un revendeur s'est connecté pour la première fois |
| Événement | Description |
|---|---|
partner.account.suspended | Un partenaire a suspendu l'un de ses comptes |
partner.account.resumed | Un partenaire a réactivé l'un de ses comptes suspendus |
partner.esim.ready | Une eSIM commandée par un partenaire est prête à installer |
partner.esim.failed | Une eSIM commandée par un partenaire n'a pas pu être provisionnée |
partner.esim.data_low | Une eSIM commandée par un partenaire a utilisé 80 % de ses données du mois |
partner.esim.data_exhausted | Une eSIM commandée par un partenaire a utilisé toutes ses données du mois |
partner.sender_id.validated | Allo a validé un Sender ID déclaré par un partenaire |
partner.sender_id.failed | Allo a refusé un Sender ID déclaré par un partenaire |
call.received
Declenche lorsqu'un appel entrant commence a sonner, avant que l'appel ne soit decroche. Lorsqu'un contact correspondant est trouve, l'evenement inclut les objets person, company et deals avec le contexte du contact.
{
"topic": "call.received",
"version": "2.0",
"timestamp": "2025-03-15T14:30:00.000Z",
"data": {
"from_number": "+33612345678",
"to_number": "+33112345678",
"started_at": "2025-03-15T14:30:00.000Z",
"user_email": "[email protected]",
"person": {
"id": "con_5MiGNHp2vI1AN6sTu4Cw",
"name": "Marie",
"last_name": "Dupont",
"email": "[email protected]",
"emails": ["[email protected]"],
"numbers": ["+33612345678"],
"job_title": "Head of Sales",
"linkedin_url": "https://linkedin.com/in/mariedupont",
"lead_source": "Inbound"
},
"company": {
"id": "com-a1b2c3d4e5f6",
"name": "Acme Corp"
},
"deals": [
{
"id": "dea-x1y2z3w4v5u6",
"name": "Enterprise Plan",
"status": "qualified",
"value": 25000.00,
"currency": "EUR",
"close_date": "2025-06-15T00:00:00"
}
]
}
}
| Champ | Type | Description |
|---|---|---|
from_number | string | Numero de telephone de l'appelant |
to_number | string | Votre numero de telephone Allo |
started_at | string | Horodatage ISO 8601 du debut de la sonnerie |
user_email | string | Email de l'utilisateur Allo assigne au numero |
person | object ou null | Contact correspondant. Absent si aucun contact ne correspond au numero de l'appelant. |
company | object ou null | Entreprise liee au contact. null si aucune. |
deals | array ou null | Deals lies au contact. null si aucun. |
Objet Person
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du contact |
name | string ou null | Prenom |
last_name | string ou null | Nom de famille |
email | string ou null | Adresse email principale |
emails | array of strings | Toutes les adresses email |
numbers | array of strings | Tous les numeros de telephone |
job_title | string ou null | Intitule du poste |
<property> | any | Chaque propriete de contact que vous avez definie apparait comme une cle de premier niveau (par ex., linkedin_url, lead_source). Seules les valeurs non nulles sont incluses. |
Objet Company
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique de l'entreprise |
name | string ou null | Nom de l'entreprise |
Objet Deal
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du deal |
name | string ou null | Nom du deal |
status | string ou null | Etape ou statut du deal |
value | number ou null | Valeur monetaire du deal |
currency | string ou null | Code de la devise (par ex., EUR, USD) |
close_date | string ou null | Date de cloture prevue (ISO 8601) |
call.triggered
Declenche lorsqu'un appel sortant est initie. Lorsqu'un contact correspondant est trouve, l'evenement inclut les objets person, company et deals avec le contexte du contact.
{
"topic": "call.triggered",
"version": "2.0",
"timestamp": "2025-03-15T14:35:00.000Z",
"data": {
"from_number": "+33112345678",
"to_number": "+33612345678",
"started_at": "2025-03-15T14:35:00.000Z",
"user_email": "[email protected]",
"person": {
"id": "con_5MiGNHp2vI1AN6sTu4Cw",
"name": "Marie",
"last_name": "Dupont",
"email": "[email protected]",
"emails": ["[email protected]"],
"numbers": ["+33612345678"],
"job_title": "Head of Sales"
},
"company": {
"id": "com-a1b2c3d4e5f6",
"name": "Acme Corp"
},
"deals": null
}
}
| Champ | Type | Description |
|---|---|---|
from_number | string | Votre numero de telephone Allo |
to_number | string | Numero de telephone du destinataire |
started_at | string | Horodatage ISO 8601 du lancement de l'appel |
user_email | string | Email de l'utilisateur Allo qui a passe l'appel |
person | object ou null | Contact correspondant. Absent si aucun contact ne correspond au numero du destinataire. |
company | object ou null | Entreprise liee au contact. null si aucune. |
deals | array ou null | Deals lies au contact. null si aucun. |
Les objets person, company et deals utilisent le meme schema que call.received.
call.answered
Declenche au moment ou un appel est decroche de l'autre cote, pour les appels entrants comme sortants -- apres call.received / call.triggered (sonnerie) et avant call.completed (raccrochage). Utilisez-le pour reagir en temps reel lorsque le prospect decroche. Lorsqu'un contact correspondant est trouve, l'evenement inclut les objets person, company et deals avec le contexte du contact.
{
"topic": "call.answered",
"version": "2.0",
"timestamp": "2025-03-15T14:30:08.000Z",
"data": {
"from_number": "+33612345678",
"to_number": "+33112345678",
"direction": "OUTBOUND",
"started_at": "2025-03-15T14:30:00.000Z",
"answered_at": "2025-03-15T14:30:08.000Z",
"user_email": "[email protected]",
"person": {
"id": "con_5MiGNHp2vI1AN6sTu4Cw",
"name": "Marie",
"last_name": "Dupont",
"email": "[email protected]",
"emails": ["[email protected]"],
"numbers": ["+33612345678"],
"job_title": "Head of Sales"
},
"company": {
"id": "com-a1b2c3d4e5f6",
"name": "Acme Corp"
},
"deals": null
}
}
| Champ | Type | Description |
|---|---|---|
from_number | string | Numero de telephone de l'appelant |
to_number | string | Numero de telephone du destinataire |
direction | string | INBOUND ou OUTBOUND |
started_at | string | Horodatage ISO 8601 du debut de la sonnerie |
answered_at | string | Horodatage ISO 8601 du decrochage |
user_email | string | Email de l'utilisateur Allo sur l'appel |
person | object ou null | Contact correspondant. Absent si aucun contact ne correspond au numero de l'autre partie. |
company | object ou null | Entreprise liee au contact. null si aucune. |
deals | array ou null | Deals lies au contact. null si aucun. |
Les objets person, company et deals utilisent le meme schema que call.received.
call.completed
Declenche apres la fin d'un appel. Inclut toutes les donnees de l'appel : enregistrement, transcription, resume, tags et details de transfert. Cet evenement est generalement envoye environ 30 secondes apres la fin de l'appel.
{
"topic": "call.completed",
"version": "2.0",
"timestamp": "2025-03-15T14:45:00.000Z",
"data": {
"id": "cll_2NfDKEm9sF8xK3pQr1Zt",
"start_date": "2025-03-15T14:30:00.000Z",
"recording_url": "https://storage.withallo.com/recordings/abc123.mp3",
"recording_download_url": "https://storage.withallo.com/object/sign/recordings/abc123.mp3?token=eyJhbGciOi...",
"recording_download_expires_at": "2025-03-17T14:45:30Z",
"from_number": "+33612345678",
"from_name": "Marie Dupont",
"to": "+33112345678",
"to_name": "Support Acme",
"length_in_minutes": 5.5,
"length": "5m 30s",
"tag": "support",
"tags": ["support", "urgent"],
"summary": "The customer called about a billing issue with their last invoice. The agent confirmed the charge was correct and explained the new pricing plan.",
"transcriptions": [
{
"source": "EXTERNAL",
"time": "2025-03-15T14:30:05.000Z",
"text": "Hi, I have a question about my last invoice."
},
{
"source": "USER",
"time": "2025-03-15T14:30:12.000Z",
"text": "Of course, let me pull up your account."
}
],
"concatenated_transcript": "Hi, I have a question about my last invoice.\nOf course, let me pull up your account.",
"data_collected": {
"account_number": "12345"
},
"type": "INBOUND",
"result": "ANSWERED",
"integration_id": null,
"transfer_from": {
"number": null,
"user_email": null,
"user_name": null
},
"transfer_to": {
"number": null,
"user_email": null,
"user_name": null
},
"user_email": "[email protected]",
"original_to_number": null,
"original_to_name": null,
"transfer_original_call_id": null,
"ivr_result": [
{
"dtmf_key": "2",
"text_key": "Support"
}
]
}
}
Champs
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique de l'appel |
start_date | string | Horodatage ISO 8601 du debut de l'appel |
recording_url | string ou null | URL de l'enregistrement de l'appel (MP3). Null si l'enregistrement est désactivé, et sur les comptes vendus sous la marque d'un partenaire en marque blanche : utilisez recording_download_url sur ces comptes. |
recording_download_url | string ou null | Lien signé qui télécharge l'enregistrement sans connexion à Allo, valable 48 heures. Présent uniquement sur les lignes des comptes créés par un partenaire, jamais pour un appel d'une équipe HIPAA. Voir Lien de téléchargement de l'enregistrement. |
recording_download_expires_at | string ou null | Horodatage ISO 8601 de l'expiration de recording_download_url, 48 heures après la création de l'événement. |
from_number | string | Numero de telephone de l'appelant |
from_name | string | Nom de l'appelant (depuis les contacts) ou nom de votre entreprise |
to | string | Numero de telephone du destinataire |
to_name | string | Nom du destinataire (depuis les contacts) ou nom de votre entreprise |
length_in_minutes | number | Duree de l'appel en minutes (decimal) |
length | string | Duree lisible (par ex., "5m 30s") |
tag | string ou null | Tag principal assigne a l'appel |
tags | array of strings | Tous les tags assignes a l'appel |
summary | string | Resume de l'appel genere par l'IA |
transcriptions | array | Entrees de la transcription de l'appel (voir ci-dessous) |
concatenated_transcript | string | Transcription complete en une seule chaine de caracteres |
data_collected | object | Champ historique conservé pour compatibilité. C'est un objet vide sur les appels actuels. Les coordonnées que l'IA relève pendant un appel sont dans extracted_data, dans l'API Conversations |
type | string | INBOUND ou OUTBOUND |
result | string | Résultat de l'appel (voir les valeurs ci-dessous). Un appel sortant qui a abouti sur une messagerie renvoie VOICEMAIL |
integration_id | string ou null | Identifiant d'integration CRM externe pour le contact |
transfer_from | object | Details de l'origine du transfert (voir ci-dessous) |
transfer_to | object | Details de la destination du transfert (voir ci-dessous) |
user_email | string | Email de l'utilisateur Allo qui a gere l'appel |
original_to_number | string ou null | Numero compose a l'origine (si l'appel a ete route) |
original_to_name | string ou null | Nom du destinataire d'origine |
transfer_original_call_id | string ou null | Identifiant de l'appel d'origine s'il s'agit d'un transfert |
ivr_result | array | Selections du menu SVI effectuees pendant l'appel (voir ci-dessous) |
Lien de téléchargement de l'enregistrement
recording_download_url permet à votre serveur de télécharger le fichier de l'enregistrement sans connexion à Allo. Il reste valable 48 heures, soit toute la durée des nouvelles tentatives d'envoi du webhook : une tentative tardive porte encore un lien valide. Téléchargez le fichier à la réception de l'événement, ou appelez plus tard Obtenir le lien de téléchargement d'un enregistrement pour un nouveau lien valable 60 minutes.
Allo ne renseigne ce lien que sur les lignes des comptes créés par un partenaire. Il vaut null sur tous les autres comptes, sur les appels sans enregistrement et sur les appels d'une équipe HIPAA. Toute personne qui a le lien peut télécharger l'enregistrement jusqu'à son expiration : gardez-le sur votre serveur.
Valeurs du resultat d'appel
| Valeur | Description |
|---|---|
ANSWERED | Une personne a décroché. Pour les appels sortants, detected_outbound_voicemail dans l'API Conversations distingue un humain d'un répondeur |
VOICEMAIL | L'appel a abouti sur une messagerie. En entrant, l'appelant a joint votre messagerie. En sortant, la messagerie de l'interlocuteur a décroché |
TRANSFERRED_AI | La réceptionniste IA a traité l'appel |
TRANSFERRED_EXTERNAL | L'appel a été renvoyé vers un numéro externe |
BLOCKED | L'appel a été bloqué, par exemple un numéro bloqué ou un spam |
FAILED | L'appel n'a pas pu être connecté |
FAILED_EXTERNAL | Le renvoi vers un numéro externe a échoué. Uniquement sur des appels anciens |
RECEIVED | Un appel entrant auquel personne n'a répondu, sans message vocal |
CLOSED | L'appel s'est terminé avant que quelqu'un décroche, par exemple l'appelant a raccroché pendant la sonnerie |
Gérez les valeurs inconnues sans erreur : de nouveaux résultats peuvent être ajoutés.
Entree de transcription
| Champ | Type | Description |
|---|---|---|
source | string | USER (votre cote) ou EXTERNAL (appelant/destinataire) |
time | string | Horodatage ISO 8601 du segment de transcription |
text | string | Texte transcrit |
Objet Transfer
| Champ | Type | Description |
|---|---|---|
number | string ou null | Numero de telephone implique dans le transfert |
user_email | string ou null | Email de l'utilisateur Allo |
user_name | string ou null | Nom de l'utilisateur Allo |
Entree IVR result
| Champ | Type | Description |
|---|---|---|
dtmf_key | string ou null | Touche DTMF pressee par l'appelant |
text_key | string ou null | Libelle du menu selectionne |
tag.added
Declenche lorsqu'un tag est ajoute a un appel.
{
"topic": "tag.added",
"version": "2.0",
"timestamp": "2025-03-15T15:00:00.000Z",
"data": {
"call_id": "cll_2NfDKEm9sF8xK3pQr1Zt",
"tag_key": "urgent",
"tag_name": "Urgent",
"user_email": "[email protected]"
}
}
| Champ | Type | Description |
|---|---|---|
call_id | string | Identifiant de l'appel auquel le tag a ete ajoute |
tag_key | string | Identifiant du tag |
tag_name | string | Nom lisible du tag |
user_email | string ou null | Email de l'utilisateur qui a ajoute le tag |
tag.removed
Declenche lorsqu'un tag est supprime d'un appel.
{
"topic": "tag.removed",
"version": "2.0",
"timestamp": "2025-03-15T15:05:00.000Z",
"data": {
"call_id": "cll_2NfDKEm9sF8xK3pQr1Zt",
"tag_key": "urgent",
"tag_name": "Urgent",
"user_email": "[email protected]"
}
}
| Champ | Type | Description |
|---|---|---|
call_id | string | Identifiant de l'appel dont le tag a ete supprime |
tag_key | string | Identifiant du tag |
tag_name | string | Nom lisible du tag |
user_email | string ou null | Email de l'utilisateur qui a supprime le tag |
sms.received
Declenche lorsqu'un SMS entrant est recu.
{
"topic": "sms.received",
"version": "2.0",
"timestamp": "2025-03-15T16:00:00.000Z",
"data": {
"id": "msg_3KgELFn0tG9yL4qRs2Au",
"direction": "INBOUND",
"type": "MMS",
"content": "Here is a photo of the damage.",
"sent_at": "2025-03-15T16:00:00.000Z",
"from_number": "+33612345678",
"to_number": "+33112345678",
"from_name": "Marie Dupont",
"to_name": "Support Acme",
"user_email": "[email protected]",
"attachments": [
{
"file_name": "IMG_0412.jpg",
"content_type": "image/jpeg",
"file_size": 245760,
"download_url": "https://...IMG_0412.jpg?X-Amz-Expires=1800&X-Amz-Signature=...",
"download_expires_at": "2025-03-15T16:30:00Z"
}
]
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du message |
direction | string | INBOUND |
type | string | SMS ou MMS |
content | string | Texte du message |
sent_at | string | Horodatage ISO 8601 |
from_number | string | Numero de telephone de l'expediteur |
to_number | string | Votre numero de telephone Allo |
from_name | string | Nom de l'expediteur (depuis les contacts) |
to_name | string | Nom de votre entreprise |
user_email | string | Email de l'utilisateur Allo assigne au numero |
attachments | array | Photos et autres fichiers envoyés avec le message. Vide pour un message sans fichier. Voir Fichiers joints des messages. |
Fichiers joints des messages
Chaque élément de attachments contient ces champs :
| Champ | Type | Description |
|---|---|---|
file_name | string | Nom du fichier |
content_type | string | Type MIME, par exemple image/jpeg |
file_size | integer ou null | Taille en octets |
download_url | string ou null | Lien signé qui télécharge le fichier sans connexion à Allo, valable 30 minutes. null pour un message d'une équipe HIPAA, ou quand Allo n'a pas pu signer le lien. |
download_expires_at | string ou null | Horodatage ISO 8601 à partir duquel download_url ne fonctionne plus |
Téléchargez le fichier dès réception de l'événement, et enregistrez le fichier plutôt que le lien. Une livraison relancée peut arriver après l'expiration du lien : pour un nouveau lien, appelez Obtenir un élément de conversation avec l'id du message.
Quand Allo ne parvient pas à charger les fichiers d'un message, l'événement est quand même livré, sans le champ attachments. Appelez Obtenir un élément de conversation avec l'id du message pour les récupérer.
sms.sent
Declenche lorsqu'un SMS sortant est envoye.
{
"topic": "sms.sent",
"version": "2.0",
"timestamp": "2025-03-15T16:10:00.000Z",
"data": {
"id": "msg_4LhFMGo1uH0zM5rSt3Bv",
"direction": "OUTBOUND",
"type": "SMS",
"content": "Your appointment is confirmed for tomorrow at 2pm.",
"sent_at": "2025-03-15T16:10:00.000Z",
"from_number": "+33112345678",
"to_number": "+33612345678",
"from_name": "Support Acme",
"to_name": "Marie Dupont",
"user_email": "[email protected]",
"attachments": []
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du message |
direction | string | OUTBOUND |
type | string | SMS ou MMS |
content | string | Texte du message |
sent_at | string | Horodatage ISO 8601 |
from_number | string | Votre numero de telephone Allo |
to_number | string | Numero de telephone du destinataire |
from_name | string | Nom de votre entreprise |
to_name | string | Nom du destinataire (depuis les contacts) |
user_email | string | Email de l'utilisateur Allo qui a envoye le message |
attachments | array | Photos et autres fichiers envoyés avec le message. Même format que dans sms.received. |
contact.created
Declenche lorsqu'un nouveau contact est cree.
{
"topic": "contact.created",
"version": "2.0",
"timestamp": "2025-03-15T17:00:00.000Z",
"data": {
"id": "con_5MiGNHp2vI1AN6sTu4Cw",
"name": "Marie",
"last_name": "Dupont",
"company": "Acme Corp",
"emails": ["[email protected]"],
"numbers": ["+33612345678"]
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du contact |
name | string | Prenom |
last_name | string | Nom de famille |
company | string ou null | Nom de l'entreprise |
emails | array of strings ou null | Adresses email |
numbers | array of strings | Numeros de telephone |
contact.updated
Declenche lorsqu'un contact existant est modifie.
{
"topic": "contact.updated",
"version": "2.0",
"timestamp": "2025-03-15T17:05:00.000Z",
"data": {
"id": "con_5MiGNHp2vI1AN6sTu4Cw",
"name": "Marie",
"last_name": "Dupont",
"company": "Acme Corp",
"emails": ["[email protected]", "[email protected]"],
"numbers": ["+33612345678", "+33698765432"]
}
}
La structure du payload est identique a contact.created. L'objet data contient l'etat complet du contact apres la mise a jour.
summary.updated
Déclenché lorsque quelqu'un modifie le résumé d'un appel, dans les apps Allo ou avec Modifier le résumé. Seules les modifications du résumé qu'Allo affiche par défaut pour cet appel le déclenchent : le modèle de résumé par défaut du numéro, ou le résumé standard si le numéro n'en a pas. Le résumé généré par l'IA est livré dans call.completed.
{
"topic": "summary.updated",
"version": "2.0",
"timestamp": "2026-10-14T09:12:00.000Z",
"data": {
"call_id": "cll-2NfDKEm9sF8xK3pQr1Zt",
"template_key": "MARKDOWN_CLASSIC",
"content": "Le client a demandé les tarifs et a réservé une démo jeudi à 14 h.",
"version": 2,
"updated_at": "2026-10-14T09:12:00.123456",
"updated_by_email": "[email protected]",
"contact_name": "Marie Dupont"
}
}
| Champ | Type | Description |
|---|---|---|
call_id | string | ID de l'appel auquel appartient le résumé (cll-*), comme dans call.completed et l'API Conversations |
template_key | string | Modèle de résumé utilisé pour générer le résumé, par exemple MARKDOWN_CLASSIC ou l'un des modèles de votre équipe |
content | string | Le résumé complet après modification (Markdown) |
version | integer | Version du résumé, incrémentée à chaque modification. Servez-vous-en pour ignorer un événement plus ancien qui arrive en retard |
updated_at | string | Horodatage ISO 8601 de la modification |
updated_by_email | string ou null | Email de l'utilisateur qui a fait la modification |
contact_name | string ou null | Nom de la personne avec qui l'appel a eu lieu, d'après votre CRM. null si le numéro ne correspond à aucune personne |
conversation_note.created
Déclenché lorsqu'une note interne est ajoutée à une conversation, depuis les applications Allo ou via l'API Notes. Les événements conversation_note.created sont dédupliqués par ID de note : vous en recevez au plus un par note.
{
"topic": "conversation_note.created",
"version": "2.0",
"timestamp": "2026-07-13T10:00:00.000Z",
"data": {
"id": "not-2NyMabc123",
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"user": {
"id": "usr-def456",
"name": "John Smith",
"email": "[email protected]"
},
"mentions": [
{
"user_id": "usr-abc123",
"name": "Jane Doe"
}
],
"created_at": "2026-07-13T10:00:00",
"updated_at": "2026-07-13T10:00:00",
"deleted": false
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique de la note (not-*) |
content | string | Texte de la note, avec les mentions inline sous la forme @[Name](usr-...) |
allo_number | string | La ligne Allo à laquelle la conversation est rattachée |
contact_number | string | Le numéro de téléphone du contact |
user | object ou null | Auteur de la note (voir ci-dessous) |
mentions | array | Utilisateurs mentionnés dans la note (voir ci-dessous) |
created_at | string | Timestamp ISO 8601 de création de la note |
updated_at | string | Timestamp ISO 8601 de la dernière modification |
deleted | boolean | false sur conversation_note.created et conversation_note.updated, true sur conversation_note.deleted |
Objet user
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique de l'utilisateur (usr-*) |
name | string ou null | Nom affiché |
email | string ou null | Adresse email |
Entrée mention
| Champ | Type | Description |
|---|---|---|
user_id | string | ID de l'utilisateur mentionné |
name | string ou null | Nom affiché de l'utilisateur mentionné |
conversation_note.updated
Déclenché lorsque le contenu d'une note de conversation est modifié. La structure du payload est identique à conversation_note.created, avec les content, mentions et updated_at mis à jour. Contrairement aux événements *.created, conversation_note.updated peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
conversation_note.deleted
Déclenché lorsqu'une note de conversation est supprimée. La structure du payload est identique à conversation_note.created, avec l'état final de la note et deleted: true. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
contact_note.created
Déclenché lorsqu'une note est ajoutée au profil CRM d'une personne, depuis les applications Allo ou via l'API Notes. Les événements contact_note.created sont dédupliqués par ID de note : vous en recevez au plus un par note.
{
"topic": "contact_note.created",
"version": "2.0",
"timestamp": "2026-07-13T10:00:00.000Z",
"data": {
"id": "cno-abc123",
"contact_id": "con-abc123",
"person_id": "per-abc123",
"content": "Prefers email over calls. Intro by @[Jane Doe](usr-abc123).",
"user": {
"id": "usr-def456",
"name": "John Smith",
"email": "[email protected]"
},
"mentions": [
{
"user_id": "usr-abc123",
"name": "Jane Doe"
}
],
"created_at": "2026-07-13T10:00:00",
"updated_at": "2026-07-13T10:00:00",
"deleted": false
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique de la note (cno-*) |
contact_id | string | ID de la fiche contact sous-jacente (con-*), correspondant aux ids des événements contact.created / contact.updated |
person_id | string ou null | ID de la personne à laquelle la note est attachée (per-*). null lorsque la note appartient à un contact sans personne. |
content | string | Texte de la note, avec les mentions inline sous la forme @[Name](usr-...) |
user | object ou null | Auteur de la note |
mentions | array | Utilisateurs mentionnés dans la note |
created_at | string | Timestamp ISO 8601 de création de la note |
updated_at | string | Timestamp ISO 8601 de la dernière modification |
deleted | boolean | false sur contact_note.created et contact_note.updated, true sur contact_note.deleted |
Les objets user et mentions utilisent le même schéma que conversation_note.created.
contact_note.updated
Déclenché lorsque le contenu d'une note de personne est modifié. La structure du payload est identique à contact_note.created, avec les content, mentions et updated_at mis à jour. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
contact_note.deleted
Déclenché lorsqu'une note de personne est supprimée. La structure du payload est identique à contact_note.created, avec l'état final de la note et deleted: true. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
thread.created
Déclenché lorsqu'un fil de discussion est démarré sur un élément de conversation (un appel, un SMS ou une note de conversation), depuis les applications Allo ou via l'API Threads. Inclut le premier commentaire du fil. Les événements thread.created sont dédupliqués par ID de fil : vous en recevez au plus un par fil.
{
"topic": "thread.created",
"version": "2.0",
"timestamp": "2026-07-13T10:00:00.000Z",
"data": {
"id": "cth-abc123",
"entity_type": "CALL",
"entity_id": "cll-abc123",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"resolved": false,
"resolved_at": null,
"resolved_by": null,
"comment_count": 1,
"created_at": "2026-07-13T10:00:00",
"comment": {
"id": "thc-abc123",
"thread_id": "cth-abc123",
"content": "Can someone call them back today? @[Jane Doe](usr-abc123)",
"user": {
"id": "usr-def456",
"name": "John Smith",
"email": "[email protected]"
},
"mentions": [
{
"user_id": "usr-abc123",
"name": "Jane Doe"
}
],
"created_at": "2026-07-13T10:00:00",
"updated_at": "2026-07-13T10:00:00"
}
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du fil (cth-*) |
entity_type | string | Type de l'élément auquel le fil est attaché : CALL, TEXT_MESSAGE ou CONVERSATION_NOTE |
entity_id | string ou null | ID de l'élément de conversation (cll-*, msg-* ou not-*) |
allo_number | string | La ligne Allo à laquelle la conversation est rattachée |
contact_number | string | Le numéro de téléphone du contact |
resolved | boolean | Si le fil est résolu |
resolved_at | string ou null | Timestamp ISO 8601 de la résolution du fil |
resolved_by | object ou null | Utilisateur qui a résolu le fil |
comment_count | number | Nombre de commentaires du fil |
created_at | string | Timestamp ISO 8601 de création du fil |
comment | object | Le premier commentaire du fil (voir ci-dessous) |
Objet comment
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du commentaire (thc-*) |
thread_id | string | ID du fil auquel le commentaire appartient |
content | string | Texte du commentaire, avec les mentions inline sous la forme @[Name](usr-...) |
user | object ou null | Auteur du commentaire |
mentions | array | Utilisateurs mentionnés dans le commentaire |
created_at | string | Timestamp ISO 8601 de création du commentaire |
updated_at | string | Timestamp ISO 8601 de la dernière modification |
Les objets user, resolved_by et mentions utilisent le même schéma que conversation_note.created.
thread.comment.created
Déclenché lorsqu'un commentaire est ajouté à un fil existant. data est l'objet comment de thread.created. Les événements thread.comment.created sont dédupliqués par ID de commentaire : vous en recevez au plus un par commentaire.
{
"topic": "thread.comment.created",
"version": "2.0",
"timestamp": "2026-07-13T10:05:00.000Z",
"data": {
"id": "thc-def456",
"thread_id": "cth-abc123",
"content": "On it.",
"user": {
"id": "usr-abc123",
"name": "Jane Doe",
"email": "[email protected]"
},
"mentions": [],
"created_at": "2026-07-13T10:05:00",
"updated_at": "2026-07-13T10:05:00"
}
}
thread.comment.updated
Déclenché lorsque le contenu d'un commentaire de fil est modifié. data est l'objet comment de thread.created, avec les content, mentions et updated_at mis à jour. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
thread.resolved
Déclenché lorsqu'un fil est marqué comme résolu. data est l'objet thread de thread.created sans le champ comment. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
{
"topic": "thread.resolved",
"version": "2.0",
"timestamp": "2026-07-13T11:00:00.000Z",
"data": {
"id": "cth-abc123",
"entity_type": "CALL",
"entity_id": "cll-abc123",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"resolved": true,
"resolved_at": "2026-07-13T11:00:00",
"resolved_by": {
"id": "usr-def456",
"name": "John Smith",
"email": "[email protected]"
},
"comment_count": 2,
"created_at": "2026-07-13T10:00:00"
}
}
thread.unresolved
Déclenché lorsqu'un fil résolu est rouvert. La structure du payload est identique à thread.resolved, avec resolved: false et resolved_at / resolved_by à null. Peut être re-livré. Dédupliquez avec l'en-tête webhook-id.
teammate_message.created
Déclenché lorsqu'un coéquipier envoie un message direct à un autre coéquipier dans les apps Allo. Ces messages sont privés : l'événement n'est livré qu'à un endpoint webhook qui appartient à l'expéditeur ou au destinataire, et à personne d'autre. Un endpoint partagé avec le reste de l'équipe, comme celui qu'un admin d'équipe configure pour tous, ne le reçoit pas.
{
"topic": "teammate_message.created",
"version": "2.0",
"timestamp": "2026-10-14T09:30:00.000Z",
"data": {
"id": "tmsg-2NyMabc123",
"content": "Tu peux rappeler Marie Dupont ? Elle t'a demandé.",
"from_user": {
"id": "usr-def456",
"name": "John Smith",
"email": "[email protected]"
},
"to_user": {
"id": "usr-abc123",
"name": "Jane Doe",
"email": "[email protected]"
},
"sent_at": "2026-10-14T09:30:00"
}
}
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant unique du message (tmsg-*) |
content | string | Texte du message |
from_user | object | Expéditeur (voir Objet user) |
to_user | object | Destinataire (voir Objet user) |
sent_at | string | Horodatage ISO 8601 de l'envoi du message |
partner.account.login
Declenche lorsqu'un compte provisionne par un revendeur se connecte sur un appareil pour la premiere fois, le moment ou son numero devient actif. Livre au endpoint webhook du partenaire (pas celui du compte), pour que les revendeurs suivent l'activation.
{
"topic": "partner.account.login",
"version": "2.0",
"timestamp": "2025-03-15T18:00:00.000Z",
"data": {
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"email": "[email protected]",
"name": "Vibrant Occasions Event Rentals"
}
}
| Champ | Type | Description |
|---|---|---|
account_id | string | L'identifiant utilisateur du compte provisionne (usr-*) |
partner_client_ref | string ou null | Votre propre reference, definie a la creation du compte |
email | string | L'email du compte |
name | string | Le nom du compte |
partner.account.suspended
Déclenché quand vous suspendez l'un de vos comptes avec Suspendre un compte. Livré au endpoint webhook du partenaire (pas celui du compte). Suspendre un compte déjà suspendu n'envoie pas de second événement.
{
"topic": "partner.account.suspended",
"version": "2.0",
"timestamp": "2026-10-27T09:30:00.000Z",
"data": {
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"status": "SUSPENDED"
}
}
| Champ | Type | Description |
|---|---|---|
account_id | string | L'identifiant utilisateur du compte provisionné (usr-*) |
partner_client_ref | string ou null | Votre propre référence, définie à la création du compte |
status | string | SUSPENDED sur cet événement |
partner.account.resumed
Déclenché quand vous réactivez un compte suspendu avec Réactiver un compte. Livré au endpoint webhook du partenaire (pas celui du compte). Le payload a les mêmes champs que partner.account.suspended, avec status égal au statut propre du compte, par exemple ACTIVE. Réactiver un compte qui n'est pas suspendu n'envoie aucun événement.
{
"topic": "partner.account.resumed",
"version": "2.0",
"timestamp": "2026-10-30T14:05:00.000Z",
"data": {
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"status": "ACTIVE"
}
}
Chaque événement porte le statut au moment du changement : une suspension suivie d'une réactivation rapide livre SUSPENDED puis ACTIVE, même si les deux arrivent après la réactivation.
partner.esim.ready
Déclenché lorsqu'une eSIM commandée avec Commander une eSIM est prête, en général 5 à 15 minutes après la commande. À partir de ce moment, les appels vers le numéro sonnent sur l'eSIM. Livré à l'endpoint webhook du partenaire (pas à celui du compte). Le payload ne contient jamais le code d'activation : récupérez-le avec Obtenir le code d'activation d'une eSIM.
{
"topic": "partner.esim.ready",
"version": "2.0",
"timestamp": "2026-10-14T10:17:00.000Z",
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"status": "ACTIVE",
"failure_code": null,
"data": {
"used_mb": 0,
"allowance_mb": 20480,
"remaining_mb": 20480,
"cycle_started_at": "2026-09-30T22:00:00",
"cycle_ends_at": "2026-10-31T23:00:00"
}
}
}
| Champ | Type | Description |
|---|---|---|
esim_id | string | L'identifiant de l'eSIM (eso-*), tel que renvoyé par Commander une eSIM |
account_id | string | L'identifiant utilisateur du compte provisionné (usr-*) |
partner_client_ref | string ou null | Votre propre référence, définie à la création du compte |
phone_number | string | Le numéro porté par l'eSIM |
tier | string | Le code du palier commandé |
status | string | PROVISIONING, ACTIVE ou FAILED. ACTIVE pour cet événement |
failure_code | string ou null | null pour cet événement |
data | object ou null | Consommation de données mobiles du mois : used_mb, allowance_mb, remaining_mb, cycle_started_at et cycle_ends_at, comme renvoyés par Obtenir une eSIM. Pour cet événement, le nouveau quota, avec used_mb à 0 ou null. null pour partner.esim.failed |
partner.esim.failed
Déclenché lorsqu'une eSIM que vous avez commandée n'a pas pu être provisionnée. Livré à l'endpoint webhook du partenaire (pas à celui du compte). Le payload a les mêmes champs que partner.esim.ready, avec status: FAILED, failure_code renseigné avec la raison et data à null.
{
"topic": "partner.esim.failed",
"version": "2.0",
"timestamp": "2026-10-14T10:20:00.000Z",
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"status": "FAILED",
"failure_code": "ESIM_STOCK_EMPTY",
"data": null
}
}
partner.esim.data_low
Déclenché lorsqu'une eSIM que vous avez commandée a utilisé 80 % de son quota de données mobiles du mois. Livré à l'endpoint webhook du partenaire (pas à celui du compte). Le seuil de 80 % laisse un cinquième du quota, de 1 à 4 Go selon le palier, pour acheter une recharge ou monter de palier avant que les données mobiles ne s'arrêtent.
{
"topic": "partner.esim.data_low",
"version": "2.0",
"timestamp": "2026-11-18T14:30:00.000Z",
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"status": "ACTIVE",
"failure_code": null,
"data": {
"used_mb": 16420,
"allowance_mb": 20480,
"remaining_mb": 4060,
"cycle_started_at": "2026-10-31T23:00:00",
"cycle_ends_at": "2026-11-30T23:00:00"
}
}
}
Le payload a les mêmes champs que partner.esim.ready, avec data lu au moment de la vérification.
partner.esim.data_exhausted
Déclenché lorsqu'une eSIM que vous avez commandée a utilisé tout son quota de données mobiles du mois. Livré à l'endpoint webhook du partenaire (pas à celui du compte). Les données mobiles de l'eSIM s'arrêtent jusqu'au mois suivant, ou jusqu'à ce que vous achetiez une recharge ou montiez de palier. Les appels et les SMS continuent de fonctionner, et la ligne n'est jamais facturée pour des données au-delà du quota.
{
"topic": "partner.esim.data_exhausted",
"version": "2.0",
"timestamp": "2026-11-24T09:15:00.000Z",
"data": {
"esim_id": "eso-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"phone_number": "+33745805999",
"tier": "ESIM_20GB",
"status": "ACTIVE",
"failure_code": null,
"data": {
"used_mb": 20480,
"allowance_mb": 20480,
"remaining_mb": 0,
"cycle_started_at": "2026-10-31T23:00:00",
"cycle_ends_at": "2026-11-30T23:00:00"
}
}
}
Le payload a les mêmes champs que partner.esim.ready, avec data lu au moment de la vérification.
Quand les événements de données sont envoyés
- Allo vérifie la consommation de chaque eSIM active toutes les 15 minutes environ. Un événement peut donc arriver jusqu'à 15 minutes environ après le franchissement du seuil.
- Chaque événement est envoyé au plus une fois par eSIM, par mois et par quota. Une recharge ou une montée de palier relève le quota : les deux événements peuvent alors être envoyés à nouveau quand l'eSIM approche du nouveau quota.
- Si l'eSIM est passée de moins de 80 % à 100 % entre deux vérifications, seul
partner.esim.data_exhaustedest envoyé. - Le cycle est le mois civil, à l'heure de Paris. Un nouveau mois remet la consommation à zéro, et les événements peuvent être envoyés à nouveau.
partner.sender_id.validated
Déclenché lorsqu'Allo valide un Sender ID déclaré avec Déclarer un Sender ID. À partir de ce moment, le compte peut envoyer des SMS avec lui. Livré à l'endpoint webhook du partenaire (pas à celui du compte), une fois à chaque passage d'un Sender ID à VALIDATED.
{
"topic": "partner.sender_id.validated",
"version": "2.0",
"timestamp": "2026-11-18T14:30:00.000Z",
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"sender_id": "PLOMBMARTIN",
"status": "VALIDATED"
}
}
| Champ | Type | Description |
|---|---|---|
id | string | L'identifiant du Sender ID (vsi-*), tel que renvoyé par Déclarer un Sender ID |
account_id | string | L'identifiant utilisateur du compte provisionné (usr-*) |
partner_client_ref | string ou null | Votre propre référence, définie à la création du compte |
sender_id | string | Le nom que voient les destinataires |
status | string | VALIDATED pour cet événement |
partner.sender_id.failed
Déclenché lorsqu'Allo refuse un Sender ID que vous avez déclaré. Déclarez un autre nom pour le compte. Livré à l'endpoint webhook du partenaire (pas à celui du compte), une fois à chaque passage d'un Sender ID à FAILED. Le payload a les mêmes champs que partner.sender_id.validated, avec status: FAILED.
{
"topic": "partner.sender_id.failed",
"version": "2.0",
"timestamp": "2026-11-18T14:30:00.000Z",
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-160F3A46629692CF6E022E09A6217A4F0AD21B45",
"partner_client_ref": "client-4271",
"sender_id": "PLOMBMARTIN",
"status": "FAILED"
}
}
Aucun webhook n'est envoyé quand Allo désactive un Sender ID validé. Consultez son status avec Obtenir un Sender ID.