Events
Triggering Webhook Types
The following event types are associated with the Message event payload from Aircall.Aircall Message SentAircall Message ReceivedAircall Message Status Updated
{
"body": null,
"created_at": null,
"external_number": null,
"id": "1779973182949pqnihpvazdyw6336",
"number": {
"availability_status": "open",
"country": "US",
"digits": null,
"id": 1284757,
"name": "Support Line",
"time_zone": "America/Chicago"
},
"origin": "native",
"status": "received"
}
{
"body": "Text content of the message",
"created_at": "ISO 8601 timestamp when the message was created",
"external_number": "Phone number of the external party (contact)",
"id": "Unique Aircall message ID",
"number": {
"availability_status": "Availability status of the number",
"country": "Two-letter country code",
"digits": "Phone number of the Aircall virtual line",
"id": "Unique Aircall number ID",
"name": "Display name of the Aircall number",
"time_zone": "IANA time zone of the Aircall number"
},
"origin": "Origin channel of the message",
"status": "Delivery status of the message"
}
Payload Field Details
Event Payload
Hide fields
Hide fields
string
required
Unique Aircall message ID
CEL
id
Example
"1779973182949pqnihpvazdyw6336"
string
required
Delivery status of the message
CEL
status
Example
"received"
string
required
PII Text content of the messageCEL
body
Example
null
string
required
ISO 8601 timestamp when the message was created
CEL
created_at
Example
null
string
required
PII Phone number of the external party (contact)CEL
external_number
Example
null
string
required
Origin channel of the message
CEL
origin
Example
"native"
object
required
The Aircall virtual number that sent or received this message
CEL
number
Example
{
"availability_status": "open",
"country": "US",
"digits": null,
"id": 1284757,
"name": "Support Line",
"time_zone": "America/Chicago"
}
int64
required
Unique Aircall number ID
CEL
number.id
Example
1284757
string
required
Display name of the Aircall number
CEL
number.name
Example
"Support Line"
string
required
PII Phone number of the Aircall virtual lineCEL
number.digits
Example
null
string
required
Two-letter country code
CEL
number.country
Example
"US"
string
required
IANA time zone of the Aircall number
CEL
number.time_zone
Example
"America/Chicago"
string
required
Availability status of the number
CEL
number.availability_status
Example
"open"
