Notifications

API Reference for ProcessMaker Notification API

Create or update a new setting

post

Create a new Settings css-override

Authorizations

passportbearer

Body

variablesstringoptional

sansSerifFontstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json' \
  --data '{
    "variables": "text",
    "sansSerifFont": "text"
  }'

201

201

{
  "key": "text",
  "config": [
    {}
  ],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2025-03-28T01:25:04.570Z",
  "updated_at": "2025-03-28T01:25:04.570Z"
}

success

Returns all notifications that the user has access to

get

Display a listing of the resource.

Authorizations

passportbearer

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 · enum · default: "asc"optional

Options: asc, desc

per_pageinteger · default: "10"optional

includestring · default: ""optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/notifications'

200

200

{
  "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-03-28T01:25:04.570Z",
      "created_at": "2025-03-28T01:25:04.570Z",
      "updated_at": "2025-03-28T01:25:04.570Z"
    }
  ],
  "meta": null
}

list of notifications

Save a new notifications

post

Store a newly created resource in storage.

Authorizations

passportbearer

Body

typestringoptional

Represents a notification definition.

notifiable_typestringoptional

notifiable_idintegeroptional

datastringoptional

namestringoptional

messagestringoptional

processNamestringoptional

userNamestringoptional

request_idstringoptional

urlstringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "text",
    "notifiable_type": "text",
    "notifiable_id": 1,
    "data": "text",
    "name": "text",
    "message": "text",
    "processName": "text",
    "userName": "text",
    "request_id": "text",
    "url": "text"
  }'

201

201

{
  "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-03-28T01:25:04.570Z",
  "created_at": "2025-03-28T01:25:04.570Z",
  "updated_at": "2025-03-28T01:25:04.570Z"
}

success

Get single notification by ID

get

Display the specified resource.

Authorizations

passportbearer

Path parameters

notification_idstringrequired

ID of notification to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/1.0/notifications/{notification_id}'

200

200

{
  "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-03-28T01:25:04.570Z",
  "created_at": "2025-03-28T01:25:04.570Z",
  "updated_at": "2025-03-28T01:25:04.570Z"
}

Successfully found the notification

Update a notification

put

Update a user

Authorizations

passportbearer

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/notifications/{notification_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "text",
    "notifiable_type": "text",
    "notifiable_id": 1,
    "data": "text",
    "name": "text",
    "message": "text",
    "processName": "text",
    "userName": "text",
    "request_id": "text",
    "url": "text"
  }'

204

204

No body

success

Delete a notification

delete

Delete a notification

Authorizations

passportbearer

Path parameters

notification_idstringrequired

ID of notification to return

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/1.0/notifications/{notification_id}'

204

204

No body

success

Mark notifications as read by the user

put

Update notification as read

Authorizations

passportbearer

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/read_notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "message_ids": [
      "text"
    ],
    "routes": [
      "text"
    ]
  }'

201

201

No body

success

Mark notifications as unread by the user

put

Update notifications as unread

Authorizations

passportbearer

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/unread_notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "message_ids": [
      "text"
    ],
    "routes": [
      "text"
    ]
  }'

201

201

No body

success

Mark notifications as read by id and type

put

Update all notification as read.

Authorizations

passportbearer

Body

idintegeroptional

Polymorphic relation id

typestringoptional

Polymorphic relation type

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/read_all_notifications' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "type": "text"
  }'

201

201

No body

success