Chatops Api Specifications

/api/v1/passThrough/sync

/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

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

resourceIds: List of email Ids

channelId: channel id of the collaborator channel

/api/v1/archiveChannel/sync

Archive 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 )

channelId: channel id of the collaborator channel

/api/v1/findResources/sync

Find Channel Members 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 )

channelId: channel id of the collaborator channel

/api/v1/createChannel/sync

Create Channel in Slack

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelName: channel name to be created

isPrivate: true for private, false for public ( default to false )

/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

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel

/api/v1/unarchiveConversationChannel/sync

Unarchive Channel 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

/api/v1/postMessageToUser/sync

Post Message to User by Channel Id and Email Id

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel

emailId: email id of user to post the message

text: message to post

/api/v1/getChannelInactiveTime/sync

Get Channel Inactive Time 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

/api/v1/getRoles/sync

Get 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

/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/addReaction/sync

Add Reaction to a Message in Channel by Channel Id

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

ts: timestamp of message to add reactions in channel

channelId: channel id of the collaborator channel

/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

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

ts: timestamp of the message to get reactions from

channelId: channel id of the collaborator channel

/api/v1/sendDirectMessageToUser/sync

Send Direct Message to a user by email Id

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

emailId: email id of user to send direct message to

message: message to post,

/api/v1/sendDirectMessageToUsers/sync

Send Direct Message to a user by email Id

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelId: channel id of the collaborator channel

/api/v1/getUserProfileLink/sync

get user Profile link by email Id

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

emailID: Email ID of user to get profile link

/api/v1/createGroupConversation/sync

Initiate a Group Conversation between multiple users

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

emailID: Email ID of user to get profile link

message: message to start a conversation

/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/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

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

/api/v1/getOpenTickets/sync

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

/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

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelName: channel name to be created

isPrivate: true for private, false for public ( default to false )

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

get icd change requests with given server names

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

channelName: channel name to be created

isPrivate: true for private, false for public ( default to false )

/api/v1/pa/createGroupConversation/sync

Initiate a Group Conversation between multiple users

Request Parameters:

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

workspaceName: Uniquely identifies workspace name of ChatOps

emailID: Email ID of user to get profile link

message: message to start a conversation

/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

Post Operational tasks by region to the collection