Notifications

API Reference for ProcessMaker Notification API

Create or update a new setting

post

Create a new Settings css-override

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

variablesstringOptional

sansSerifFontstringOptional

Responses

201

success

application/json

post

/customize-ui

HTTPcURLJavaScriptPython

POST /api/1.0/customize-ui HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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": "2026-01-07T12:40:24.380Z",
  "updated_at": "2026-01-07T12:40:24.380Z"
}

Returns all notifications that the user has access to

get

Display a listing of the resource.

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

/notifications

HTTPcURLJavaScriptPython

GET /api/1.0/notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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": "2026-01-07T12:40:24.380Z",
      "created_at": "2026-01-07T12:40:24.380Z",
      "updated_at": "2026-01-07T12:40:24.380Z"
    }
  ],
  "meta": null
}

Save a new notifications

post

Store a newly created resource in storage.

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

typestringOptional

Represents a notification definition.

notifiable_typestringOptional

notifiable_idintegerOptional

datastringOptional

namestringOptional

messagestringOptional

processNamestringOptional

userNamestringOptional

request_idstringOptional

urlstringOptional

Responses

201

success

application/json

post

/notifications

HTTPcURLJavaScriptPython

POST /api/1.0/notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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": "2026-01-07T12:40:24.380Z",
  "created_at": "2026-01-07T12:40:24.380Z",
  "updated_at": "2026-01-07T12:40:24.380Z"
}

Get single notification by ID

get

Display the specified resource.

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

notification_idstringRequired

ID of notification to return

Responses

200

Successfully found the notification

application/json

get

/notifications/{notification_id}

HTTPcURLJavaScriptPython

GET /api/1.0/notifications/{notification_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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": "2026-01-07T12:40:24.380Z",
  "created_at": "2026-01-07T12:40:24.380Z",
  "updated_at": "2026-01-07T12:40:24.380Z"
}

Update a notification

put

Update a user

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

notification_idstringRequired

ID of notification to return

Body

application/json

typestringOptional

Represents a notification definition.

notifiable_typestringOptional

notifiable_idintegerOptional

datastringOptional

namestringOptional

messagestringOptional

processNamestringOptional

userNamestringOptional

request_idstringOptional

urlstringOptional

Responses

204

success

put

/notifications/{notification_id}

HTTPcURLJavaScriptPython

PUT /api/1.0/notifications/{notification_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

notification_idstringRequired

ID of notification to return

Responses

204

success

delete

/notifications/{notification_id}

HTTPcURLJavaScriptPython

DELETE /api/1.0/notifications/{notification_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

success

No content

Mark notifications as read by the user

put

Update notification as read

Authorizations

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

/read_notifications

HTTPcURLJavaScriptPython

PUT /api/1.0/read_notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

/unread_notifications

HTTPcURLJavaScriptPython

PUT /api/1.0/unread_notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_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

passport & bearer

OAuth2authorizationCodeRequired

Laravel passport oauth2 security.

Authorization URL: Token URL: Refresh URL:

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idintegerOptional

Polymorphic relation id

typestringOptional

Polymorphic relation type

Responses

201

success

No content

put

/read_all_notifications

HTTPcURLJavaScriptPython

PUT /api/1.0/read_all_notifications HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "id": 1,
  "type": "text"
}

201

success

No content