Notifications

API Reference for ProcessMaker Notification API

Create or update a new setting

Create a new Settings css-override

POST/api/1.0/customize-ui

Body

application/json

variablesstring

sansSerifFontstring

Response

201

success

Body

application/json

keystring

Class Settings

configarray of object

namestring

helperstring

groupstring

formatstring

hiddenboolean

readonlyboolean

variablesstring

sansSerifFontstring

idstring (id)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/customize-ui', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "key": "text",
  "config": [],
  "name": "text",
  "helper": "text",
  "group": "text",
  "format": "text",
  "hidden": false,
  "readonly": false,
  "variables": "text",
  "sansSerifFont": "text",
  "id": "text",
  "created_at": "2024-11-16T07:30:22.443Z",
  "updated_at": "2024-11-16T07:30:22.443Z"
}

Returns all notifications that the user has access to

Display a listing of the resource.

GET/api/1.0/notifications

Query parameters

Response

200

list of notifications

Body

application/json

dataarray of Notification (all of)

metaany

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "type": "text",
      "notifiable_type": "text",
      "data": "text",
      "name": "text",
      "message": "text",
      "processName": "text",
      "userName": "text",
      "request_id": "text",
      "url": "text",
      "id": "text",
      "read_at": "2024-11-16T07:30:22.443Z",
      "created_at": "2024-11-16T07:30:22.443Z",
      "updated_at": "2024-11-16T07:30:22.443Z"
    }
  ]
}

Save a new notifications

Store a newly created resource in storage.

POST/api/1.0/notifications

Body

application/json

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

Response

201

success

Body

application/json

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

idstring

read_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/notifications', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "type": "text",
  "notifiable_type": "text",
  "data": "text",
  "name": "text",
  "message": "text",
  "processName": "text",
  "userName": "text",
  "request_id": "text",
  "url": "text",
  "id": "text",
  "read_at": "2024-11-16T07:30:22.443Z",
  "created_at": "2024-11-16T07:30:22.443Z",
  "updated_at": "2024-11-16T07:30:22.443Z"
}

Get single notification by ID

Display the specified resource.

GET/api/1.0/notifications/{notification_id}

Path parameters

notification_id*string

ID of notification to return

Response

200

Successfully found the notification

Body

application/json

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

idstring

read_atstring (date-time)

created_atstring (date-time)

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/notifications/{notification_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "text",
  "notifiable_type": "text",
  "data": "text",
  "name": "text",
  "message": "text",
  "processName": "text",
  "userName": "text",
  "request_id": "text",
  "url": "text",
  "id": "text",
  "read_at": "2024-11-16T07:30:22.443Z",
  "created_at": "2024-11-16T07:30:22.443Z",
  "updated_at": "2024-11-16T07:30:22.443Z"
}

Update a notification

Update a user

PUT/api/1.0/notifications/{notification_id}

Path parameters

notification_id*string

ID of notification to return

Body

application/json

typestring

Represents a notification definition.

notifiable_typestring

notifiable_idinteger

datastring

namestring

messagestring

processNamestring

userNamestring

request_idstring

urlstring

Response

204

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/notifications/{notification_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a notification

Delete a notification

DELETE/api/1.0/notifications/{notification_id}

Path parameters

notification_id*string

ID of notification to return

Response

204

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/notifications/{notification_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Mark notifications as read by the user

Update notification as read

PUT/api/1.0/read_notifications

Body

application/json

message_idsarray of string

list of message ids that will be marked as read

routesarray of string

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

Response

201

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/read_notifications', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Mark notifications as unread by the user

Update notifications as unread

PUT/api/1.0/unread_notifications

Body

application/json

message_idsarray of string

list of message ids that will be marked as read

routesarray of string

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

Response

201

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/unread_notifications', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Mark notifications as read by id and type

Update all notification as read.

PUT/api/1.0/read_all_notifications

Body

application/json

idinteger

Polymorphic relation id

typestring

Polymorphic relation type

Response

201

success

Request

JavaScriptCurlPython

const response = await fetch('/api/1.0/read_all_notifications', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();