Chatops Api Specifications

/ping

/healthCheck

/api/root/ping

/api/v1/initiateIncident [DEPRECATED]

Create Channel with Incident Details

/initiateChatOpsIncidentProcess [DEPRECATED]

Create Channel with Incident Details

/updateChatOpsIncident [DEPRECATED]

Update Channel with Incident Details

/api/v1/updateIncident [DEPRECATED]

Update Channel with Incident Details

/api/v1/account

Get Account On Boarded

/api/v1/initiateTicket

Create Channel with Ticket Details

/api/v1/updateTicket

Update Channel with Ticket Details

/api/v1/updateTicketInEcosystem

Update Ticket in ChatOps Ecosystem

Request Parameters:

ticketId: Identifies unique Ticket Id ( Required )

createIncidentChannel: if set to true, creates a incident channel for onboarded/non-onboarded Accounts with assignments if any(Optional)

status: Status of the ticket (Optional, supported values [ Hold| Inprogress | Discovery | Resolve | Close ])

assignmentEmails:List of email Ids to be added in the channel (Optional,supported values for roles [ROLE_DPE | ROLE_PRACTITIONER | ROLE_INC_COMMANDER | NONE] )

notificationEmails:Email ids of those who gets notified in the Index Channel when updates happen (Optional)

/api/v1/getOpenTickets

Get Open Tickets for an Account filtered by type(Ticket Priority(number) and isMajor(boolean))

/api/v1/getOpenTickets/sync

Get Open Tickets for an Account filtered by type(Ticket Priority(number) and isMajor(boolean))

/api/v1/externalansiblelaunch

/postMessageToChannel [DEPRECATED]

Post Message to a Channel

/api/v1/postMessage [DEPRECATED]

Post Message to a Channel

/api/v2/postMessage

Post Message to a Channel

/api/v3/postMessage

Post Message to a Channel

/api/v1/addResources

Add resources to Channel by Email IDs

/api/v1/archiveChannel

Archive Channel by Channel Id

/api/v1/findResources

Find Channel Members by Channel Id

/api/v1/createChannel

Create Channel in Slack

/api/v1/setPurposeConversationChannel

Set Conversation Purpose to a Channel by Channel Id

/api/v1/setTopicConversationChannel

Sets the Topic for a Conversation in a Channel

/api/v1/getChannelConversationInfo

Retrieves information about a conversation in a Channel

/api/v1/unarchiveConversationChannel

Unarchive Channel by Channel Id

/api/v1/getConversationHistory

Get Conversation History of a Channel

Request Parameters:

callbackUrl: URL used to return Response ( Optional )

accountCodeLocators: Uniquely Identifies the account,(Optional against workspaceName)

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional against accountCodeLocators )

channelId: channel id of the collaborator channel ( Optional against ticketId )

ticketId: ticket id of the collaborator channel ( Optional against channelId, if provided given first precedence )

latest: timestamp from which messages to be displayed ( Optional, if provided limit should be given )

oldest: timestamp to which messages to be displayed ( Optional, if provided limit should be given )

limit: number of messages to be displayed ( Optional, if provided then latest/oldest timestamp value should be given )

cursor: [next_cursor] value to be provided given in response if it has more messages to be displayed ( Optional )

/api/v1/pinMessageToChannel

Pin Message to a Channel

/api/v1/addReaction

Add Reaction to a Message in Channel by Channel Id

/api/v1/deleteMessageInChannel

Deletes a Message in a Channel using Channel Id

/api/v1/getMessageReactionInChannel

Get Reaction to a Message in Channel by Channel Id

/api/v1/postMessageToUser

Post Message to User by Channel Id and Email Id

/api/v1/getChannelInactiveTime

Get Channel Inactive Time by Channel Id

/api/v1/getChatPlatformInfo

Get Chat Platform Information by Channel Id

/api/v1/getRoles

Get Roles by Channel Id

/api/v1/assignRole

Assign Roles by Ticket Id

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

accountCodeLocators: Uniquely Identifies the account,(Optional against workspaceName)

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional and if provided given first precedence )

ticketId: ticket id of the collaborator channel

channelId: channel Id of the collaborator channel(Optional)

roles: roles that user can be mapped

"roleName": "INC Commander" / "Practitioner" / "DPE"

"users": "Email Id of users to assign roles"

/api/v1/sendDirectMessageToUser

Send Direct Message to a user by email Id

/api/v1/sendDirectMessageToUsers

Send Direct Message to a user by email Id

/api/v1/postMessage/sync

Post Message to a Channel

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

message: message to post in slack ( Slack message object Message Builder )

channelId: channel id of the collaborator channel

ts: timestamp of message to which text to be posted as reply ( Optional )

isUpdate: true if request is update, false if its new request ( Optional, defaults to true )

/api/v1/addResources/sync

Add resources to Channel by Email IDs

/api/v1/archiveChannel/sync

Archive Channel by Channel Id

/api/v1/findResources/sync

Find Channel Members by Channel Id

/api/v1/createChannel/sync

Create Channel in Slack

/api/v1/pinMessageToChannel/sync

Pin Message to a Channel

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional and if provided given first precedence )

ts: timestamp of message to pin in channel

channelId: channel id of the collaborator channel

/api/v1/getConversationHistory/sync

Get Conversation History of a Channel

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel

latest: timestamp from which messages to be displayed ( Optional, if provided limit should be given )

oldest: timestamp to which messages to be displayed ( Optional, if provided limit should be given )

limit: number of messages to be displayed ( Optional, if provided then latest/oldest timestamp value should be given )

cursor: [next_cursor] value to be provided given in response if it has more messages to be displayed ( Optional )

/api/v1/setPurposeConversationChannel/sync

Set Conversation Purpose to a Channel by Channel Id

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional and if provided given first precedence )

purpose: Channel description

channelId: channel id of the collaborator channel

/api/v1/setTopicConversationChannel/sync

Sets the Topic for a conversation in a channel

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional and if provided given first precedence )

topic: Channel description

channelId: channel id of the collaborator channel

/api/v1/getChannelConversationInfo/sync

Retrieves information about a conversation in a Channel

/api/v1/unarchiveConversationChannel/sync

Unarchive Channel by Channel Id

/api/v1/postMessageToUser/sync

Post Message to User by Channel Id and Email Id

/api/v1/getChannelInactiveTime/sync

Get Channel Inactive Time by Channel Id

/api/v1/getChatPlatformInfo/sync

Get Chat Platform Information by Channel Id

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel ( Optional against ticketId )

ticketId: ticket id of the collaborator channel ( Optional against channelId, if provided given first precedence )

/api/v1/getRoles/sync

Get Roles by Ticket Id

/api/v1/assignRole/sync

Assign Roles by Ticket Id

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

ticketId: ticket Id of the collaborator channel

channelId: channel Id of the collaborator channel(Optional)

roles: roles that user can be mapped to

"roleName": "INC Commander" / "Practitioner" / "DPE"

"users": "Email Id of users to assign roles"

/api/v1/postModalToChannel

Post Modal to Channel by Channel Id, available in async mode to deal with response window of slack

Request Parameters:

callbackUrl: URL used to return Response ( Optional )

accountCodeLocators: Uniquely Identifies the account,(Optional against workspaceName)

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps ( Optional against accountCodeLocators )

view: modal to post in slack ( Slack message object: Message Builder )

channelId: channel id of the collaborator channel ( Optional against ticketId )

ticketId: ticket id of the collaborator channel ( Optional against channelId, if provided given first precedence

callbackId: used as a reference on submit button

triggerId: Unique for each trigger, generated by slack and avalable in actionPayload)

/api/v1/addReaction/sync

Add Reaction to a Message in Channel by Channel Id

/api/v1/getGroupMembers

Find Channel Members by Channel Id

/api/v1/deleteMessageInChannel/sync

Deletes a Message in a Channel using Channel Id

Request Parameters:

callbackUrl: URL used to return Response ( Optional )

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

ts: timestamp of message to be deleted

channelId: channel id of the collaborator channel

/api/v1/getMessageReactionInChannel/sync

Get Reaction to a Message in Channel by Channel Id

/api/v1/sendDirectMessageToUser/sync

Send Direct Message to a user by email Id

/api/v1/sendDirectMessageToUsers/sync

Send Direct Message to a user by email Id

/api/v1/getUserProfileLink/sync

get user Profile link by email Id

/api/v1/getUserProfileLink

get user Profile link by email Id

/api/v1/createGroupConversation

Initiate a Group Conversation between multiple users

/api/v1/createGroupConversation/sync

Initiate a Group Conversation between multiple users

/api/v1/fileUpload

Upload file to channel(s))

Request Parameters:

File Restricted to 10MB. Follow the link for Restricted File types:- https://slack.com/intl/en-in/help/articles/1500002249342-Restricted-file-types-in-Slack-Connect

callbackUrl: URL used to return Response ( Optional )

accountCodeLocators: Uniquely Identifies the account,(Optional against workspaceName)

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

file: select file to upload.

title: Title of file.

channels: Comma-separated list of channel names or IDs where the file will be shared.

workspaceName: Uniquely identifies workspace name of ChatOps

initialComment: The message text introducing the file in specified channels.

threadTs: Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.

/api/v1/fileUpload/sync

Upload file to channel(s))

Request Parameters:

File Restricted to 10MB. Follow the link for Restricted File types:- https://slack.com/intl/en-in/help/articles/1500002249342-Restricted-file-types-in-Slack-Connect

file: select file to upload.

title: Title of file.

channels: Comma-separated list of channel names or IDs where the file will be shared.

workspaceName: Uniquely identifies workspace name of ChatOps

initialComment: The message text introducing the file in specified channels.

threadTs: Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead.

/api/v1/postMessageWithTemplate

Post Message to a Channel With Template

/api/v2/getChatPlatformInfo

Get Chat Platform Information by Channel Id

/api/v2/getChatPlatformInfo/sync

Get Chat Platform Information by Channel Id

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel ( Optional)

ticketId: ticket id of the collaborator channel ( Optional )

/api/v1/getGroupMembers/sync

Find Channel Members by Channel Id

/api/v1/metrics_data

Get metrics data for a given period

Request Parameters:

from: from date ( required )

to: To date(required)

page: page no ( Optional)

per_page: No of items in a page( Optional)

/api/v1/getSubSkillDetails

Get Sub Skill API Details by Sub Skill

Request Parameters:

collabPlatform: Collaboration Platform ( Optional, supported values [SLACK] )

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel ( Optional)

ticketId: ticket id of the collaborator channel ( Optional )

/api/v1/passThrough

/api/v1/passThrough/sync

/api/v1/directIntegrationAction

/api/v1/accounts/list

/api/v1/pa/getaccounts/sync

Returns Account info

Request Parameters:

accountCodeLocators: uniquely identifies accounts

/api/v1/pa/postmessage/sync

Add resources to Channel by Email IDs

Request Parameters:

postType: ( supported values [group/user] )

message: plain message object

postingBot: Name of the Bot

email: (Optional) user email id

groupId: (Optional) group id

language: prefered value english

/api/v1/pa/postmessage/adaptivecard/sync

Add resources to Channel by Email IDs

Request Parameters:

postType: ( supported values [group/user] )

message: Adaptive Card object

postingBot: Name of the Bot

email: (Optional) user email id

groupId: (Optional) group id

language: prefered value english

/api/v1/pa/createChannel/sync

Create Channel in Slack

/api/v1/pa/icd/changerequests/sync

get icd change requests with given server names

/api/v1/pa/createGroupConversation/sync

Initiate a Group Conversation between multiple users

/api/v1/pa/createTab/sync

Create a tab in group or channel

Request Parameters:

channelId: Channel or Group Id

accountCode: Uniquely identifies account in ChatOps

/api/v1/pa/incidentdetails/sync

Returns Incident details

Request Parameters:

filter: filter can be ticket id or channel id

/api/v1/pa/postWowMetrics/sync

Post Wow metrics

Post metrics of project to the collection

/api/v1/pa/operationaltasks/checklist

Get Operational Task Checklist

fetch operational tasks for given time window in ET zone

/api/v1/pa/operationaltasks/cache

Post Operational tasks cache

Post Operational tasks cache to the collection

/api/v1/pa/operationaltasks/sync

Post Operational tasks

Post Operational tasks by region to the collection

/api/v1/pa/operationaltasks/audit

Fetch Operational tasks from audits

Fetch tasks from OperationalTaskAudits collection

/api/v1/pa/CrtGrpConvWithChannelDetails

Initiate a Group Conversation between multiple users that got saved in channel details table