Resource

Workspace Notification Log

Logs of all workspace activities including messages, channel creation, user invitations, and button interactions for Slack and Microsoft Teams.

The Workspace Notification Log Model

Properties

Name
_id
Type
Object ID
Description
ID of this object
Name
createdAt
Type
Date
Description
Date and Time when the object was created.
Name
updatedAt
Type
Date
Description
Date and Time when the object was updated.
Name
project
Type
Project
Description
Relation to Project Resource in which this object belongs
Name
projectId
Type
Object IDRequired
Description
ID of your Project in which this object belongs
Name
workspaceType
Type
TextRequired
Description
Type of Workspace - Slack, Microsoft Teams
Name
channelId
Type
Text
Description
Channel ID where the message was sent
Name
channelName
Type
Text
Description
Channel Name where the message was sent
Name
threadId
Type
Text
Description
Thread ID of the message in the channel (if any)
Name
message
Type
Very Long Text
Description
Content of the message
Name
statusMessage
Type
Long Text
Description
Status Message (if any)
Name
status
Type
TextRequired
Description
Status of the message
Name
actionType
Type
TextRequired
Description
Type of workspace action performed
Name
incident
Type
Incident
Description
Incident associated with this message (if any)
Name
incidentId
Type
Object ID
Description
ID of Incident associated with this message (if any)
Name
user
Type
User
Description
User who initiated this workspace notification (if any)
Name
userId
Type
Object ID
Description
ID of User who initiated this workspace notification (if any)
Name
alert
Type
Alert
Description
Alert associated with this message (if any)
Name
alertId
Type
Object ID
Description
ID of Alert associated with this message (if any)
Name
monitor
Type
Monitor
Description
Monitor associated with this message (if any)
Name
monitorId
Type
Object ID
Description
ID of Monitor associated with this message (if any)
Name
alertEpisode
Type
Alert Episode
Description
Alert Episode associated with this message (if any)
Name
alertEpisodeId
Type
Object ID
Description
ID of Alert Episode associated with this message (if any)
Name
incidentEpisode
Type
Incident Episode
Description
Incident Episode associated with this message (if any)
Name
incidentEpisodeId
Type
Object ID
Description
ID of Incident Episode associated with this message (if any)
Name
scheduledMaintenance
Type
Scheduled Maintenance Event
Description
Scheduled Maintenance associated with this message (if any)
Name
scheduledMaintenanceId
Type
Object ID
Description
ID of Scheduled Maintenance associated with this message (if any)
Name
statusPage
Type
Status Page
Description
Status Page associated with this message (if any)
Name
statusPageId
Type
Object ID
Description
ID of Status Page associated with this message (if any)
Name
statusPageAnnouncement
Type
Status Page Announcement
Description
Status Page Announcement associated with this message (if any)
Name
statusPageAnnouncementId
Type
Object ID
Description
ID of Status Page Announcement associated with this message (if any)
Name
onCallDutyPolicy
Type
On-Call Policy
Description
On-Call Duty Policy associated with this message (if any)
Name
onCallDutyPolicyId
Type
Object ID
Description
ID of On-Call Duty Policy associated with this message (if any)
Name
onCallDutyPolicyEscalationRule
Type
Escalation Rule
Description
On-Call Duty Policy Escalation Rule associated with this message (if any)
Name
onCallDutyPolicyEscalationRuleId
Type
Object ID
Description
ID of On-Call Duty Policy Escalation Rule associated with this message (if any)
Name
onCallDutyPolicySchedule
Type
On-Call Policy Schedule
Description
On-Call Duty Policy Schedule associated with this message (if any)
Name
onCallDutyPolicyScheduleId
Type
Object ID
Description
ID of On-Call Duty Policy Schedule associated with this message (if any)
Name
team
Type
Team
Description
Team associated with this message (if any)
Name
teamId
Type
Object ID
Description
ID of Team associated with this message (if any)

GETorPOST/api/workspace-notification-log/get-list

List

This endpoint allows you to retrieve a paginated list of all your Workspace Notification Log. By default, a maximum of ten Workspace Notification Log are shown per page.

Optional Query Params

limit
number
Number of objects to fetch. By default 10, you can increase this count up to 100
skip
number
Number of objects to skip. This can be useful in pagination

Optional Request Body

query
If you would like to filter on Workspace Notification Log. You can specify include a query here. For more information, please check out writing queries here.
select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
sort
Objects will be sorted based on created date by default. You can change the sort order — see Data Types: Sort.

List Request

POST

/api/workspace-notification-log/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "actionType": true,
    "projectId": true,
    "status": true,
    "workspaceType": true,
    "_id": true
  },
  "query": {
    "actionType": "Example action type"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "378037b0-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "378037b1-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    },
    {
      "_id": "378037b2-28fe-11f1-b591-3fdcef396aba",
      "actionType": "Example action type",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status",
      "workspaceType": "Example workspace type"
    }
  ]
}

GETorPOST/api/workspace-notification-log/:id/get-item

Get item by ID

This endpoint allows you to retrieve Workspace Notification Log by ID.

id
text
ID of the Object

Optional Request Body

select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Get Item Request

POST

/api/workspace-notification-log/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "actionType": true,
    "projectId": true,
    "status": true,
    "workspaceType": true,
    "_id": true
  }
}

Response

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "actionType": "Example action type",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status",
  "workspaceType": "Example workspace type"
}

POST/api/workspace-notification-log/count

Count

This endpoint allows you to retrieve the count of all your Workspace Notification Log.

Optional Request Body

query
If you would like to filter on Workspace Notification Log. You can specify include a query here. For more information, please check out writing queries here.

Count Request

POST

/api/workspace-notification-log/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "actionType": "Example action type"
  }
}

Response

{
  "count": 107
}

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

Required to read Workspace Notification Log

Project Owner
Project Admin
Project Member
Read Workspace Notification Log
Read All Project Resources

Create Permissions

Required to create Workspace Notification Log

This resource cannot be created via the API

Update Permissions

Required to update Workspace Notification Log

This resource cannot be updated via the API

Delete Permissions

Required to delete Workspace Notification Log

This resource cannot be deleted via the API