Data Model

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Data Model

IncidentChatChannel Object

NameRequired?Data TypeDescription

id

y

long

ID for the Everbridge Incident

name

y

string

The name/title for the Everbridge Incident

organizationId

y

long

Organization ID for the Everbridge Organization

chatChannelId

y

string

ID of the Channel created in the Chat Integration platforms like Slack, MS Teams, or Cisco WebEx Team

chatChannelName

n

string

Name of the Channel created in the Chat Integration platforms like Slack, MS Teams, or Cisco Webex Team

chatChannelStatus

n

string

Status of the Channel Integration platforms like Slack, MS Teams, or Cisco WebEx Team

chatChannelUri

y

string

URI for the Channel created in the Chat Integration platforms like Slack, MS Teams, or Cisco Webex Team
ChatChannelUri is the web URI that navigates the user to the channel in Slack, MS Teams and room in Cisco Webex Team ID:
Example:
Slack: https://://everbridge.slack.com/messages/
https://://everbridge.slack.com/messages/CMVK1NA57

Cisco Webex Team: https://://web.ciscoWebex Team.com/teams/f9591b10-f0b6-11e7-b282-cf64641095b5/rooms/af28e250-cf7b-11e9-af6b-8bc417d3866e/chat
(https://://web.ciscoWebex Team.com/teams//rooms//chat )

MS Teams:
https://://teams.microsoft.com/l/team/19:55227f374009442c8a41ab9d537786f5%40thread.skype/conversations?groupId=d7584e2a-95f6-4de9-bb8c-4cabf1e97a34&tenantId=4165d148-14c1-4df5-a2da-415870be0535

chatChannelType

y

string

Type of Chat Integration platforms like Slack, MS Teams, or Cisco Webex Team