Notifications

API Reference for ProcessMaker Notification API

Create or update a new setting

Create a new Settings css-override

post

/customize-ui

Authorizations

passportbearer

Body

variablesstring

sansSerifFontstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/customize-ui' \
  --header 'Content-Type: application/json'

201

201

{
  "key": "text",
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": true,
  "readonly": true,
  "variables": "text",
  "sansSerifFont": "text",
  "config": [
    {}
  ],
  "id": "text",
  "created_at": "2025-02-20T19:13:01.691Z",
  "updated_at": "2025-02-20T19:13:01.691Z"
}

success

Returns all notifications that the user has access to

Display a listing of the resource.

get

/notifications

Authorizations

passportbearer

Query parameters

statusstring

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

filterstring

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

order_bystring

Field to order results by

order_directionstring · enum · default: asc

Options: asc, desc

per_pageinteger · default: 10

includestring

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

{
  "meta": null,
  "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-02-20T19:13:01.691Z",
      "created_at": "2025-02-20T19:13:01.691Z",
      "updated_at": "2025-02-20T19:13:01.691Z"
    }
  ]
}

list of notifications

Save a new notifications

Store a newly created resource in storage.

post

/notifications

Authorizations

passportbearer

Body

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/1.0/notifications' \
  --header 'Content-Type: application/json'

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-02-20T19:13:01.691Z",
  "created_at": "2025-02-20T19:13:01.691Z",
  "updated_at": "2025-02-20T19:13:01.691Z"
}

success

Get single notification by ID

Display the specified resource.

get

/notifications/{notification_id}

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-02-20T19:13:01.691Z",
  "created_at": "2025-02-20T19:13:01.691Z",
  "updated_at": "2025-02-20T19:13:01.691Z"
}

Successfully found the notification

Update a notification

Update a user

put

/notifications/{notification_id}

Authorizations

passportbearer

Path parameters

notification_idstringrequired

ID of notification to return

Body

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/1.0/notifications/{notification_id}' \
  --header 'Content-Type: application/json'

204

204

No body

success

Delete a notification

Delete a notification

delete

/notifications/{notification_id}

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

Update notification as read

put

/read_notifications

Authorizations

passportbearer

Body

message_idsstring[]

list of message ids that will be marked as read

routesstring[]

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":[null],"routes":[null]}'

201

201

No body

success

Mark notifications as unread by the user

Update notifications as unread

put

/unread_notifications

Authorizations

passportbearer

Body

message_idsstring[]

list of message ids that will be marked as read

routesstring[]

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":[null],"routes":[null]}'

201

201

No body

success

Mark notifications as read by id and type

Update all notification as read.

put

/read_all_notifications

Authorizations

passportbearer

Body

idinteger

Polymorphic relation id

typestring

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'

201

201

No body

success