Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.
ITA Mobile APIs
API to Retrieve Incident Information
Case: Where incident with given id exists and has valid token
{
"data": {
"id": 444206992591034,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"notificationResources": [
26061,
26061
],
"Affected Services": [
"Email"
],
"Priority": [
"a"
],
"priority": [
"a"
]
},
"chatChannelId": "C6RND2ZC0",
"chatChannelName": "inc-591034",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C6RND2ZC0",
"createUserId": 1328214341320837,
"createUserName": "yongfei hu",
"name": "Demo Test",
"organizationId": 1234567890,
"priorityId": 30845,
"processId": 24207,
"status": "none",
"timeCreated": "2017-08-23T06:36:38Z",
"timeUpdated": "2017-08-23T06:36:38Z"
},
"included": [
{
"id": 24207,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-09-27T20:02:44Z",
"lastModifiedId": 444206992589542,
"lastModifiedName": "john.doe",
"name": "Service Ops",
"organizationId": 1234567890,
"priorityVariableIds": [
444206992593042,
444206992593837
],
"processType": "service",
"seq": 0,
"serviceVariableIds": [
444206992593051
]
}
]
}
Case where incident does not exist
{
"errors": [
{
"id": "1a99b3d6-cbd9-44d7-ab5c-0351a516d5b8",
"code": "NOT_FOUND",
"title": "Not Found",
"detail": "Resource not found",
"meta": {
"resource": "incident",
"id": 4442069925910444
},
"status": "404"
}
]
}
Case where token is not valid
{
"error": {
"code": 401,
"message": "BaseController.verifyRecipient[line: 215]: Access token is invalid"
}
}
Incident which does not have Slack channel created
{
"data": {
"id": 444206992590655,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"Today's Date": [
"07-14-2017"
],
"Affected Services": [
"Water",
"DNS"
],
"service": [
"Water",
"DNS"
],
"Priority": [
"P63"
],
"priority": [
"P63"
]
},
"createUserId": 444206992589578,
"createUserName": "xyz",
"name": "NewPDSecOpsTemplate",
"organizationId": 1234567890,
"priorityId": 26139,
"processId": 24208,
"status": "notAcknowledged",
"timeCreated": "2017-07-14T15:39:07Z",
"timeUpdated": "2017-07-14T15:39:07Z"
},
"included": [
{
"id": 24208,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-09-27T20:02:44Z",
"lastModifiedId": 444206992589542,
"lastModifiedName": "john.doe",
"name": "Security Ops",
"organizationId": 1234567890,
"priorityVariableIds": [
444206992593042
],
"processType": "security",
"seq": 1,
"serviceVariableIds": [
444206992593051
]
}
]
}
API to Get Information if Slack is Configured for the User’s Org or Not
When Slack is not set up
GET /gateway/api/chatops/chatinteg/team?accountId=453003085611581
{
"authenticated": false,
"message": "slack token not set up"
}
When Slack is set up
{
"data": {
"authenticated": true,
"name": "everbridge-test",
"id": "T5WMQ51DH",
"domain": "everbridge-test",
"email_domain": "everbridge.com",
"chatType": "Slack"
}
}
When Cisco Spark is set up for org
{
"data": {
"authenticated": true,
"name": "ITA-2",
"chatType": "Cisco Spark"
}
}
API to Retrieve Channel Information or Create Channel if it Does Not Exist
Incident ID is invalid
GET /gateway/api/chatops/chatinteg/incident/444206992590722/channel/info?accountId=453003085611581
{
"authenticated": false,
"message": "Invalid incident details"
}
Channel exists for the incident
GET /gateway/api/chatops/chatinteg/incident/ 444206992591034/channel/info?accountId=453003085611581
{
"data": {
"id": 444206992591034,
"name": "Demo TEst",
"organizationId": 1234567890,
"chatChannelId": "C6RND2ZC0",
"chatChannelName": "inc-591034",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C6RND2ZC0"
}
}
When channel does not exist, it will create channel
GET /gateway/api/chatops/chatinteg/incident/444206992590522/channel/info?accountId=453003085611581
{
"data": {
"id": 444206992590522,
"name": "ITA test template",
"organizationId": 1234567890,
"chatChannelId": "C7GTKQMFC",
"chatChannelName": "inc-590522",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C7GTKQMFC"
}
}
API to Fetch Multiple Incidents with Process Information
{
"currentPageNo": 1,
"totalPageCount": 1,
"totalCount": 5,
"pageSize": 20,
"data": [
{
"id": 444206992590522,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"Services": [
"Email",
"Power",
"DNS"
],
"notificationResources": [
26060
],
"service": [
"Email",
"Power",
"DNS"
],
"Priority": [
"P3"
],
"priority": [
"P3"
],
"Queue": [
"wer"
]
},
"chatChannelId": "C7GTKQMFC",
"chatChannelName": "inc-590522",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C7GTKQMFC",
"createUserId": 444206992589633,
"createUserName": "John Smith",
"name": "ITA test template",
"organizationId": 1234567890,
"priorityId": 25455,
"processId": 24209,
"status": "partial",
"timeCreated": "2017-06-26T19:11:36Z",
"timeUpdated": "2017-06-26T19:11:36Z"
},
{
"id": 444206992590551,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"Today's Date": [
"06-28-2017"
],
"Affected Services": [
"Network",
"Power",
"Water",
"Email",
"DNS"
],
"service": [
"Network",
"Power",
"Water",
"Email",
"DNS"
]
},
"chatChannelId": "C7CT3HB8E",
"chatChannelName": "inc-590551",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C7CT3HB8E",
"createUserId": 444206992589578,
"createUserName": "Prashant OrgAdmin",
"name": "NewPDSecOpsTemplate",
"organizationId": 1234567890,
"priorityId": 26260,
"processId": 24208,
"status": "notAcknowledged",
"timeCreated": "2017-06-28T14:30:49Z",
"timeUpdated": "2017-06-28T14:30:49Z"
},
{
"id": 444206992591034,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"notificationResources": [
26061,
26061
],
"Affected Services": [
"Email"
],
"Priority": [
"a"
],
"priority": [
"a"
]
},
"chatChannelId": "C6RND2ZC0",
"chatChannelName": "inc-591034",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C6RND2ZC0",
"createUserId": 1328214341320837,
"createUserName": "yongfei hu",
"name": "Demo TEst",
"organizationId": 1234567890,
"priorityId": 30845,
"processId": 24207,
"status": "none",
"timeCreated": "2017-08-23T06:36:38Z",
"timeUpdated": "2017-08-23T06:36:38Z"
},
{
"id": 444206992591546,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"Incident Priority": [
"PP1"
],
"Affected Services": [
"Network"
],
"Current Time": [
"17:31:15"
],
"Asset Loction": [
"Boston MA"
],
"priority": [
"PP1"
]
},
"chatChannelId": "C6ZSGRX8A",
"chatChannelName": "inc-591546",
"chatChannelStatus": "ACTIVE",
"chatChannelUri": "https://everbridge.slack.com/messages/C6ZSGRX8A",
"createUserId": 444206992589669,
"createUserName": "xyzxyz",
"name": "Server Outage",
"organizationId": 1234567890,
"priorityId": 34702,
"processId": 24207,
"status": "none",
"timeCreated": "2017-09-07T21:31:15Z",
"timeUpdated": "2017-09-07T21:31:15Z"
},
{
"id": 444206992592341,
"type": "incident",
"accountId": 8800387990738,
"attributes": {
"Today's Date": [
"10-24-2017"
],
"Current Time": [
"13:43:40"
],
"Asset Location": [
"Mumbai, India"
],
"Notification Status": [
"New"
],
"priority": [
"Unknown"
],
"Message Sender": [
"John Doe"
]
},
"createUserId": 444206992589571,
"createUserName": "John Doe",
"name": "Car Repair Issue - address now",
"organizationId": 1234567890,
"priorityId": 26244,
"processId": 24210,
"status": "none",
"timeCreated": "2017-10-24T17:43:40Z",
"timeUpdated": "2017-10-24T17:43:40Z"
}
],
"included": [
{
"id": 24207,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-10-25T18:00:16Z",
"lastModifiedId": 444206992589622,
"lastModifiedName": "xyz",
"name": "Service Ops",
"organizationId": 1234567890,
"priorityVariableIds": [
444206992593042,
444206992593837
],
"processType": "service",
"seq": 0,
"serviceVariableIds": [
444206992593051
]
},
{
"id": 24208,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-10-25T18:00:16Z",
"lastModifiedId": 444206992589622,
"lastModifiedName": "xyz",
"name": "Security Ops",
"organizationId": 1234567890,
"priorityVariableIds": [
444206992593042
],
"processType": "security",
"seq": 1,
"serviceVariableIds": [
444206992593051
]
},
{
"id": 24209,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-10-25T18:00:16Z",
"lastModifiedId": 444206992589622,
"lastModifiedName": "xyz",
"name": "Dev Ops",
"organizationId": 1234567890,
"processType": "dev",
"seq": 2,
"serviceVariableIds": [
444206992593051
]
},
{
"id": 24210,
"type": "process",
"accountId": 8800387990738,
"createdDate": "2017-06-02T14:11:34Z",
"createdId": 444206992589479,
"createdName": "john.smith",
"defaultValue": false,
"enabled": true,
"lastModifiedDate": "2017-10-25T18:00:16Z",
"lastModifiedId": 444206992589622,
"lastModifiedName": "xyz",
"name": "DR/BC Ops",
"organizationId": 1234567890,
"priorityVariableIds": [
444206992593042
],
"processType": "dr",
"seq": 3,
"serviceVariableIds": [
444206992593051
]
}
]
}