Notifications
API Reference for ProcessMaker Notification API
Create a new Settings css-override
POST /api/1.0/customize-ui HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"variables": "text",
"sansSerifFont": "text"
}
success
{
"key": "text",
"config": [
{}
],
"name": "text",
"helper": "text",
"group": "text",
"format": "text",
"hidden": true,
"readonly": true,
"variables": "text",
"sansSerifFont": "text",
"id": "text",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
Display a listing of the resource.
Only return notifications by status (unread, all, etc.)
Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.
Field to order results by
asc
Possible values: 10
Include data from related models in payload. Comma separated list.
""
GET /api/1.0/notifications HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
list of notifications
{
"data": [
{
"type": "text",
"notifiable_type": "text",
"notifiable_id": 1,
"data": "text",
"name": "text",
"message": "text",
"processName": "text",
"userName": "text",
"request_id": "text",
"url": "text",
"id": "text",
"read_at": "2025-07-04T19:26:10.013Z",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
],
"meta": null
}
Store a newly created resource in storage.
Represents a notification definition.
POST /api/1.0/notifications HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"type": "text",
"notifiable_type": "text",
"notifiable_id": 1,
"data": "text",
"name": "text",
"message": "text",
"processName": "text",
"userName": "text",
"request_id": "text",
"url": "text"
}
success
{
"type": "text",
"notifiable_type": "text",
"notifiable_id": 1,
"data": "text",
"name": "text",
"message": "text",
"processName": "text",
"userName": "text",
"request_id": "text",
"url": "text",
"id": "text",
"read_at": "2025-07-04T19:26:10.013Z",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
Display the specified resource.
ID of notification to return
GET /api/1.0/notifications/{notification_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
Successfully found the notification
{
"type": "text",
"notifiable_type": "text",
"notifiable_id": 1,
"data": "text",
"name": "text",
"message": "text",
"processName": "text",
"userName": "text",
"request_id": "text",
"url": "text",
"id": "text",
"read_at": "2025-07-04T19:26:10.013Z",
"created_at": "2025-07-04T19:26:10.013Z",
"updated_at": "2025-07-04T19:26:10.013Z"
}
Update a user
ID of notification to return
Represents a notification definition.
PUT /api/1.0/notifications/{notification_id} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 175
{
"type": "text",
"notifiable_type": "text",
"notifiable_id": 1,
"data": "text",
"name": "text",
"message": "text",
"processName": "text",
"userName": "text",
"request_id": "text",
"url": "text"
}
success
No content
Update notification as read
list of message ids that will be marked as read
all messages that has an url that is in this list will be marked as read
PUT /api/1.0/read_notifications HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"message_ids": [
"text"
],
"routes": [
"text"
]
}
success
No content
Update notifications as unread
list of message ids that will be marked as read
all messages that has an url that is in this list will be marked as read
PUT /api/1.0/unread_notifications HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"message_ids": [
"text"
],
"routes": [
"text"
]
}
success
No content
Update all notification as read.
Polymorphic relation id
Polymorphic relation type
PUT /api/1.0/read_all_notifications HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"id": 1,
"type": "text"
}
success
No content
Last updated