Skip to main content

​
Notification Created

This event occurs when a new notification is created by Apten. The webhook payload contains information about the notification that was created, including the lead’s phone number, the communication channel (email, sms, or call), the notification name (the name you define in the UI), and the notification message.

​
Payload

The following payload is sent when a notification is created: 
{
  "event": "notification",
  "data": {
    "leadId": "a7e92c5d-f301-4b89-ae16-8f35d02cx9z",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+13305551234",
    "channel": "sms",
    "notificationName": "Lead Follow-up Required",
    "notificationMessage": "This lead requires immediate follow-up attention."
  },
  "timestamp": "2024-02-18T09:45:22Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (notification).
data.leadIdstringThe unique identifier for the lead.
data.externalLeadIdstringThe CRM lead ID (Salesforce, HubSpot, or Close CRM).
data.phonestringThe phone number of the lead.
data.channelstringThe communication channel. Can be email, sms, or call.
data.notificationNamestringThe name of the notification as defined in the UI.
data.notificationMessagestringThe message content of the notification.
timestampstringThe ISO 8601 timestamp when the notification was created.