message.sent webhook event is triggered whenever your Apten assistant sends a message to a lead via SMS or email. This can be used to track outgoing communication and monitor follow-up sequences.
Payload
SMS Example
{
"event": "message.sent",
"data": {
"leadId": "c4f23a1b-d8e5-4f67-90c1-2a5b8d3e9x7y",
"externalLeadId": "003XX000004DHPY",
"phone": "+12025550189",
"channel": "sms",
"profile": "Default Profile",
"isFollowUp": true,
"followUpStep": 1,
"content": {
"text": "Hi there! Just following up on our previous conversation. Would you like to learn more about our services?"
}
},
"timestamp": "2024-01-15T14:30:00Z"
}
Email Example
{
"event": "message.sent",
"data": {
"leadId": "c4f23a1b-d8e5-4f67-90c1-2a5b8d3e9x7y",
"externalLeadId": "003XX000004DHPY",
"phone": "+12025550189",
"channel": "email",
"profile": "Default Profile",
"isFollowUp": true,
"followUpStep": 1,
"content": {
"subject": "Follow-up: Your Interest in Our Services",
"text": "Hi there! Just following up on our previous conversation. Would you like to learn more about our services?"
}
},
"timestamp": "2024-01-15T14:30:00Z"
}
Properties
| Property | Type | Description |
|---|---|---|
event | string | The webhook event type (message.sent). |
data.leadId | string | The unique identifier for the lead. |
data.externalLeadId | string | The CRM lead ID (Salesforce, HubSpot, or Close CRM). |
data.phone | string | The phone number of the lead. |
data.channel | string | The communication channel. Can be sms or email. |
data.profile | string | The customer profile assigned to the lead. |
data.isFollowUp | boolean | Indicates if this message is part of a follow-up sequence. |
data.followUpStep | number | null | The current step in the follow-up sequence. Will be null if isFollowUp is false. May also be null for older follow-ups that were scheduled before this feature was implemented. |
data.content.subject | string | The subject line of the email. Only included for email messages, not SMS. |
data.content.text | string | The content of the message sent to the lead. |
timestamp | string | The ISO 8601 timestamp when the message was sent. |