Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
Smart Channel Integration APIs
POST /chatOps/public/chatinteg/{organizationId}/channel
Description
Creates the channel for the given incident.
URL
https://://api.everbridge.net/rest/chatOps/public/chatinteg//channel?incidentId=
Method
GET
Path Variable
| Name | Required? | Data Type? | Description |
|---|---|---|---|
organizationId | y | long | The ID of the Organization |
Request Parameters
| Name | Required? | Data Type? | Description |
|---|---|---|---|
incidentId | y | long | The ID of the Everbridge Incident for which channel needs to be created |
teamId | n | string | The teamId is required when the user wants to create a channel for Cisco Webex Teams and MS Teams. The channel for the incident will be created for the teamId specified. NOTE: ◊ Slack does not use the team Id ◊ CISCO Webex Team uses team Id which is also called as roomId ◊ MS teams uses team Id which is also called as groupId |
Example
https://://api-qa1.everbridge.net/rest/chatOps/public/chatinteg/888409690212738/channel?incidentId=292886704844916
Responses
| Code | Response |
|---|---|
200 | ◊ Attributes for the given Organization ID. { "data": { "id": 292886704844916, "name": "Business Continuity Daily Update", "organizationId": 888409690212738, "chatChannelId": "CMHA0A2AH", "chatChannelName": "inc-844916", "chatChannelStatus": "ACTIVE", "chatChannelUri": "https://://everbridge.slack.com/messages/CMHA0A2AH", "chatChannelType": "Slack" } } |
◊ No attributes available for the given Organization ID. { "data": [] } | |
401 | { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } ◊ No organization access to the User. |
400 | { "authenticated": false, "message": "Invalid incident details" } |
PUT /chatOps/public/chatinteg//incident//channel
Description
Links the given channel with the Incident ID.
URL
https://://api.everbridge.net/rest/chatOps/public/chatinteg/1234567890/incident/283540855980039/channel
Method
PUT
Path Variable
| Name | Required? | Data Type? | Description |
|---|---|---|---|
organizationId | y | long | The ID of the Organization |
incidentId | y | long | The ID of the incident |
Request Header
Example
Request
Responses
| Code | Response |
|---|---|
200 | { "data": { "incidentId": 283540855980039, "id": 283540855980039, "name": "ITA Group Notification EscalationTesting", "organizationId": 1234567890, "chatChannelId": "CMB6DPEMN", "chatChannelName": "ITA Group Notification EscalationTesting", "chatChannelStatus": "ACTIVE", "chatChannelUri": "https://://everbridge.slack.com/messages/CMB6DPEMN", "chatChannelType": "Slack" } } |
401 | { "status": 401, "message": "Org 888409690212728 not accessible to this user, or does not exist." } No organization access to the User |
400 | { "authenticated": false, "message": "Invalid incident details" } |