CZERTAINLY Notification API (2.15.0)
Download OpenAPI specification:Download
REST API for notifications in the platform
Internal Notifications API that manages notifications for logged user in the platform. Note that this API does not manage nor trigger external notifications. For external notifications, please refer to the External Notification Management API.
List notifications for logged user
Authorizations:
query Parameters
unread | boolean Default: false Show only unread notifications |
itemsPerPage | integer <int32> <= 1000 Default: 10 Number of entries per page |
pageNumber | integer <int32> Default: 1 Page number for the request |
Responses
Response samples
- 200
- 400
- 403
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "message": "string",
- "detail": "string",
- "readAt": "2019-08-24T14:15:22Z",
- "sentAt": "2019-08-24T14:15:22Z",
- "targetObjectType": "NONE",
- "targetObjectIdentification": [
- "string"
]
}
]
}
Delete a list of notifications for logged user
Authorizations:
Request Body schema: application/jsonrequired
Notifications UUIDs
Responses
Request samples
- Payload
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]
Response samples
- 400
- 403
{- "message": "Error message"
}
Mark a list of notifications as read for logged user
Authorizations:
Request Body schema: application/jsonrequired
Notifications UUIDs
Responses
Request samples
- Payload
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]
Response samples
- 400
- 403
{- "message": "Error message"
}
External Notification Management API for managing notification instances that can be used to notify recipient(s) about events that were triggered in the platform. Note that this API does not handle internal notifications. For internal notifications, please refer to the Internal Notification API
Details of an Notification instance
Authorizations:
path Parameters
uuid required | string Notification instance UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}
Edit Notification instance
Authorizations:
path Parameters
uuid required | string Notification instance UUID |
Request Body schema: application/jsonrequired
description | string Notification instance description |
required | Array of objects (RequestAttributeDto) List of Notification instance Attributes |
Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes |
Responses
Request samples
- Payload
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}
Response samples
- 200
- 400
- 403
- 404
- 422
- 502
- 503
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}
List of available Notification instances
Authorizations:
Responses
Response samples
- 200
- 400
- 403
- 502
- 503
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connectorUuid": "string",
- "connectorName": "string",
- "kind": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
]
}
]
Add Notification instance
Authorizations:
Request Body schema: application/jsonrequired
description | string Notification instance description |
required | Array of objects (RequestAttributeDto) List of Notification instance Attributes |
Array of objects (AttributeMappingDto) List of attribute mappings between mapping attributes and (recipient) custom attributes | |
name required | string Notification instance name |
connectorUuid required | string UUID of Notification provider |
kind required | string Notification instance Kind |
Responses
Request samples
- Payload
{- "description": "string",
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributeMappings": [
- {
- "mappingAttributeUuid": "string",
- "mappingAttributeName": "string",
- "customAttributeUuid": "string",
- "customAttributeLabel": "string"
}
], - "name": "string",
- "connectorUuid": "string",
- "kind": "string"
}
Response samples
- 201
- 400
- 403
- 404
- 422
- 502
- 503
{- "uuid": "string"
}
List of mapping attributes
Authorizations:
path Parameters
connectorUuid required | string Connector UUID |
kind required | string Kind |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
[- {
- "version": "2",
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "description": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "type": "data",
- "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": "true",
- "group": "requiredAttributes",
- "required": "false",
- "readOnly": "false",
- "list": "false",
- "multiSelect": "false"
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]
Get Notification profile details
Authorizations:
path Parameters
uuid required | string Notification profile UUID |
query Parameters
version required | integer <int32> Select specific version of the notification profile |
Responses
Response samples
- 200
- 400
- 403
- 404
{- "uuid": "string",
- "name": "NotificationProfile1",
- "description": "Detail description of the notification profile",
- "version": "1",
- "recipientType": "none",
- "recipients": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "notificationInstance": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "internalNotification": true,
- "frequency": "P1DT12H",
- "repetitions": 0
}
Edit Notification profile
Authorizations:
path Parameters
uuid required | string Notification profile UUID |
Request Body schema: application/jsonrequired
description | string Description of the Notification profile |
recipientType required | string (RecipientType) Enum: "none" "default" "user" "group" "role" "owner" Recipient type of notifications produced by profile |
recipientUuids | Array of strings <uuid> [ items <uuid > ] Recipient UUIDs of notifications produced by profile |
notificationInstanceUuid | string <uuid> Notification instance UUID |
internalNotification required | boolean Is notification profile sending internal notifications |
frequency | string <duration> Frequency of repeated notification |
repetitions | integer <int32> Maximum number of repetitions of same notification |
Responses
Request samples
- Payload
{- "description": "Detail description of the notification profile",
- "recipientType": "none",
- "recipientUuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
- "internalNotification": true,
- "frequency": "P1DT12H",
- "repetitions": 0
}
Response samples
- 200
- 400
- 403
- 404
- 422
{- "uuid": "string",
- "name": "NotificationProfile1",
- "description": "Detail description of the notification profile",
- "version": "1",
- "recipientType": "none",
- "recipients": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "notificationInstance": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "internalNotification": true,
- "frequency": "P1DT12H",
- "repetitions": 0
}
List Notification profiles
Authorizations:
query Parameters
itemsPerPage | integer <int32> <= 1000 Default: 10 Number of entries per page |
pageNumber | integer <int32> Default: 1 Page number for the request |
Responses
Response samples
- 200
- 400
- 403
{- "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0,
- "notificationProfiles": [
- {
- "uuid": "string",
- "name": "NotificationProfile1",
- "description": "Detail description of the notification profile",
- "version": "1",
- "recipientType": "none",
- "recipientUuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
- "internalNotification": true
}
]
}
Create Notification profile
Authorizations:
Request Body schema: application/jsonrequired
description | string Description of the Notification profile |
recipientType required | string (RecipientType) Enum: "none" "default" "user" "group" "role" "owner" Recipient type of notifications produced by profile |
recipientUuids | Array of strings <uuid> [ items <uuid > ] Recipient UUIDs of notifications produced by profile |
notificationInstanceUuid | string <uuid> Notification instance UUID |
internalNotification required | boolean Is notification profile sending internal notifications |
frequency | string <duration> Frequency of repeated notification |
repetitions | integer <int32> Maximum number of repetitions of same notification |
name required | string Name of the Notification profile |
Responses
Request samples
- Payload
{- "description": "Detail description of the notification profile",
- "recipientType": "none",
- "recipientUuids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "notificationInstanceUuid": "250850b8-eed4-41a2-9559-3e2c4e8a5661",
- "internalNotification": true,
- "frequency": "P1DT12H",
- "repetitions": 0,
- "name": "NotificationProfile1"
}
Response samples
- 200
- 400
- 403
- 404
- 422
{- "uuid": "string",
- "name": "NotificationProfile1",
- "description": "Detail description of the notification profile",
- "version": "1",
- "recipientType": "none",
- "recipients": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
], - "notificationInstance": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "internalNotification": true,
- "frequency": "P1DT12H",
- "repetitions": 0
}