CZERTAINLY Notification API (2.13.1)
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
query Parameters
required | object (NotificationRequestDto) Show only unread notifications |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "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
Request Body schema: application/jsonrequired
Notifications UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 404
Content type
application/json
{- "message": "Error message"
}Mark a list of notifications as read for logged user
Request Body schema: application/jsonrequired
Notifications UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
- 404
Content type
application/json
{- "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
path Parameters
| uuid required | string Notification instance UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "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
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
Content type
application/json
{- "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
Content type
application/json
{- "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"
}
]
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "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
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
Content type
application/json
{- "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
Content type
application/json
{- "uuid": "string"
}List of mapping attributes
path Parameters
| connectorUuid required | string Connector UUID |
| kind required | string Kind |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "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": [
- {
- "description": "string",
- "errorMessage": "string",
- "type": "regExp",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": { }
}
]
}
}
]