Get all notifications sent
GET/:customer_id/admin/sentinel-notifications
Fetch a list of the notifications that were sent to all the users of a customer
Request
Path Parameters
customer_id Customer Idrequired
Id of the tenant
Query Parameters
from date-time
From date
to date-time
To date
limit Limit
Default value: 100
Pagination limit
offset Offset
Pagination offset
survey_id Survey Id
If action type includes survey_completion_check, filter by survey id
group_id Group Id
Filter by group id (optional)
action_type string[]
Possible values: [survey_completion_check, upload_frequency_check]
Filter notifications by action type
recipient_type string[]
Possible values: [email, slack-webhook, cmc-fcm]
Filter notifications that include this recipient type
Responses
- 200
- 400
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
notifications object[]required
uid uuidrequired
customer_id Customer Idrequired
alias Aliasrequired
external_id External Idrequired
group_id Group Idrequired
time date-timerequired
local_time date-timenullablerequired
action_type Action Typerequired
action_description Action Descriptionrequired
messages object[]required
recipients string[]required
subject Subjectrequired
body Bodyrequired
others objectrequired
medium Mediumrequired
Possible values: [email, slack-webhook, cmc-fcm]
other_info objectnullablerequired
{
"notifications": [
{
"uid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customer_id": "string",
"alias": "string",
"external_id": "string",
"group_id": "string",
"time": "2024-12-03T11:32:12.528Z",
"local_time": "2024-12-03T11:32:12.529Z",
"action_type": "string",
"action_description": "string",
"messages": [
{
"recipients": [
"string"
],
"subject": "string",
"body": "string",
"others": {},
"medium": "email"
}
],
"other_info": {}
}
]
}
Validation error
- application/json
- Schema
- Example (from schema)
Schema
message Messagerequired
errors undefined[]nullablerequired
{
"message": "string",
"errors": [
null
]
}
Loading...