Notification Created

The webchat.notification.created webhook event is triggered when Apten creates a notification for a webchat session. This can happen when a configured custom notification matches a webchat conversation or when a visitor requests to speak with a human agent. Webchat notifications use a separate event from the lead notification webhook. They identify the conversation with sessionId and do not include lead-specific fields such as leadId, phone, or channel. To receive this event, configure a webhook in the Developer Portal for the event webchat.notification.created. For webhook signing details, see Verifying Webhooks.

Payload

{
  "event": "webchat.notification.created",
  "timestamp": "2026-08-13T12:00:00.000Z",
  "data": {
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "orgId": "org-abc123",
    "profile": "Sales",
    "origin": "https://example.com/pricing",
    "notificationName": "High intent visitor",
    "notificationMessage": "Visitor needs attention"
  }
}

Properties

Property	Type	Description
`event`	string	The webhook event type (`webchat.notification.created`).
`data.sessionId`	string	The unique identifier for the webchat session.
`data.orgId`	string	The Apten organization ID that owns the session.
`data.profile`	string	The name of the customer profile handling the session.
`data.origin`	string	The URL where the webchat widget was opened. Only included if set.
`data.notificationName`	string	The custom notification name. Only included for notifications from a custom notification.
`data.notificationMessage`	string	The notification message created for the webchat session.
`timestamp`	string	The ISO 8601 timestamp when the notification event was created.

Get Started

Account & Security

Tutorials

Compliance

Webhooks

Integrations

Webchat

Automations

Notification Created