processmaker.comKnowledge CenterProcessMaker University
Edit

Notifications

API Reference for ProcessMaker Notification API

Create or update a new setting

post

Create a new Settings css-override

Authorizations
Body
variablesstringOptional
sansSerifFontstringOptional
Responses
201

success

application/json
Responseall of
post
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"
}
201

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-08-31T01:45:22.543Z",
  "updated_at": "2025-08-31T01:45:22.543Z"
}

Returns all notifications that the user has access to

get

Display a listing of the resource.

Authorizations
Query parameters
statusstringOptional

Only return notifications by status (unread, all, etc.)

filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

Include data from related models in payload. Comma separated list.

Default: ""
Responses
200

list of notifications

application/json
get
GET /api/1.0/notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

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-08-31T01:45:22.543Z",
      "created_at": "2025-08-31T01:45:22.543Z",
      "updated_at": "2025-08-31T01:45:22.543Z"
    }
  ],
  "meta": null
}

Save a new notifications

post

Store a newly created resource in storage.

Authorizations
Body
typestringOptional

Represents a notification definition.

notifiable_typestringOptional
notifiable_idintegerOptional
datastringOptional
namestringOptional
messagestringOptional
processNamestringOptional
userNamestringOptional
request_idstringOptional
urlstringOptional
Responses
201

success

application/json
Responseall of
post
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"
}
201

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-08-31T01:45:22.543Z",
  "created_at": "2025-08-31T01:45:22.543Z",
  "updated_at": "2025-08-31T01:45:22.543Z"
}

Get single notification by ID

get

Display the specified resource.

Authorizations
Path parameters
notification_idstringRequired

ID of notification to return

Responses
200

Successfully found the notification

application/json
Responseall of
get
GET /api/1.0/notifications/{notification_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

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-08-31T01:45:22.543Z",
  "created_at": "2025-08-31T01:45:22.543Z",
  "updated_at": "2025-08-31T01:45:22.543Z"
}

Update a notification

put

Update a user

Authorizations
Path parameters
notification_idstringRequired

ID of notification to return

Body
typestringOptional

Represents a notification definition.

notifiable_typestringOptional
notifiable_idintegerOptional
datastringOptional
namestringOptional
messagestringOptional
processNamestringOptional
userNamestringOptional
request_idstringOptional
urlstringOptional
Responses
204

success

No content
put
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"
}
204

success

No content

Delete a notification

delete

Delete a notification

Authorizations
Path parameters
notification_idstringRequired

ID of notification to return

Responses
204

success

No content
delete
DELETE /api/1.0/notifications/{notification_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Mark notifications as read by the user

put

Update notification as read

Authorizations
Body
message_idsstring[]Optional

list of message ids that will be marked as read

routesstring[]Optional

all messages that has an url that is in this list will be marked as read

Responses
201

success

No content
put
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"
  ]
}
201

success

No content

Mark notifications as unread by the user

put

Update notifications as unread

Authorizations
Body
message_idsstring[]Optional

list of message ids that will be marked as read

routesstring[]Optional

all messages that has an url that is in this list will be marked as read

Responses
201

success

No content
put
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"
  ]
}
201

success

No content

Mark notifications as read by id and type

put

Update all notification as read.

Authorizations
Body
idintegerOptional

Polymorphic relation id

typestringOptional

Polymorphic relation type

Responses
201

success

No content
put
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"
}
201

success

No content
PreviousFilesNextScripts

Last updated