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

Property	Type	Description
`event`	string	The webhook event type (`notification`).
`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 `email`, `sms`, or `call`.
`data.notificationName`	string	The name of the notification as defined in the UI.
`data.notificationMessage`	string	The message content of the notification.
`timestamp`	string	The ISO 8601 timestamp when the notification was created.

Get Started

Account & Security

Tutorials

Compliance

Webhooks

Integrations

Webchat

Automations

Notification Created

Notification Created

Payload

Properties

​Notification Created

​Payload

​Properties

Notification Created

Payload

Properties