API Reference/Documentation
GitHubDashboard
Engagement

Notifications

Send in-app and push notifications, manage notification preferences, and track notification history. Supports templates and @mention parsing.

Send notifications

In-app and push

Preferences

User notification settings

History & templates

History and templates

Send Notification

Body Parameters

ParameterTypeDescription
userIdreq
stringTarget user ID
titlereq
stringNotification title
body
stringNotification body
type
string
infoalerttaskmention
Notification type
link
stringLink URL
metadata
objectAdditional metadata
Request
HTTP
http
POST https://api.leadron.io/v1/notifications/send
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
X-Tenant-Id: acme-corp
Body
json
1
2
3
4
5
6
7
{
  "userId": "6789abcdef012345",
  "title": "New lead assigned",
  "body": "Jane Doe was assigned to you.",
  "type": "task",
  "link": "/leads/6789abcdef012345"
}
Response200OK
200 Response
json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "success": true,
  "status": 200,
  "data": {
    "id": "notif_001",
    "userId": "6789abcdef012345",
    "title": "New lead assigned",
    "read": false,
    "createdAt": "2026-02-08T14:30:00.000Z"
  },
  "meta": {
    "timestamp": "2026-02-08T14:30:00.000Z",
    "version": "v1"
  }
}

Preferences

Notification History

Templates

Mentions