Cisco Webex

the cisco webex connector allows for streamlined communication within webex by automating message handling and collaboration directly through the swimlane platform cisco webex is a leading enterprise solution for video conferencing, online meetings, screen share, and webinars the cisco webex connector for swimlane turbine enables users to automate communication and collaboration workflows within their security operations by integrating with webex, security teams can streamline incident response by sending messages, managing content, and coordinating team efforts directly through the swimlane platform this connector enhances real time communication and collaboration, ensuring rapid dissemination of critical information and cohesive team action during security incidents prerequisites to effectively utilize the cisco webex connector with swimlane turbine, ensure you have the following prerequisites custom authentication with cisco webex using the following parameter url the base endpoint url for the cisco webex api asset setup to use the cisco webex connector with swimlane turbine, you need to set up custom authentication with one of the following configurations oauth2 access token authentication with these parameter url endpoint for the cisco webex api service access token token used to authenticate api requests oauth2 refresh token authentication with these parameters url endpoint for the cisco webex api service client id your cisco webex application's client identifier client secret the secret key associated with your cisco webex application refresh token a token used to obtain a new access token when the current one expires capabilities this cisco webex connector provides the following capabilities create a message delete a message edit a message get message details list direct messages list messages configurations cisco webex custom authentication cisco webex custom authentication using access token or client credentials configuration parameters parameter description type required url a url to the target host string required access token the access token string optional client id the client id string optional client secret the client secret string optional refresh token the refresh token string optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create a message post a message in plain text, rich text, or html to a cisco webex room, with an option to include a file attachment endpoint url /v1/messages method post input argument name type required description roomid string optional the room id of the message parentid string optional the parent message to reply to topersonid string optional the person id of the recipient when sending a private 1 1 message topersonemail string optional the email address of the recipient when sending a private 1 1 message text string optional the message, in plain text if markdown is specified this parameter may be optionally used to provide alternate text for ui clients that do not support rich text markdown string optional the message, in markdown format the maximum message length is 7439 bytes html string optional the message, in html format the maximum message length is 7439 bytes attachments array optional content attachments to attach to the message contenttype string optional the content type of the attachment content object optional adaptive card content type string required must be adaptivecard version string required adaptive card schema version body array optional the card's elements type string optional type of the resource text string optional parameter for create a message size string optional parameter for create a message actions array optional the card's actions type string optional type of the resource url string optional url endpoint for the request title string optional parameter for create a message files object optional upload file the public url to a binary file to be posted into the room only one file is allowed per message uploaded files are automatically converted into a format that all webex clients can render file string optional parameter for create a message file name string optional name of the resource output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier parentid string unique identifier roomid string unique identifier roomtype string type of the resource topersonid string unique identifier topersonemail string output field topersonemail text string output field text markdown string output field markdown html string output field html files array output field files personid string unique identifier personemail string output field personemail mentionedpeople array output field mentionedpeople mentionedgroups array output field mentionedgroups attachments array output field attachments contenttype string type of the resource content object response content type string type of the resource version string output field version body array request body data type string type of the resource text string output field text size string output field size example \[ { "status code" 200, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw fe650b9d c43e 4970 a1b7 fb7fa6ffa907, routergw fe650b9d c43e 4970 a1b7 ", "date" "tue, 24 sep 2024 09 45 20 gmt", "x envoy upstream service time" "800", "vary" "origin,accept encoding", "content encoding" "gzip", "content type" "application/json", "server" "istio envoy", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "id" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "parentid" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "roomid" "y2lzy29zcgfyazovl3vzl1jpt00vymjjzwixywqtndnmms0zyju4ltkxndctzje0ymiwyzrkmtu0", "roomtype" "group", "topersonid" "y2lzy29zcgfyazovl3vzl1bft1bmrs9mmdzknzfhns0wodmzltrmytutytcyys1jyzg5yji1zwvlmmx", "topersonemail" "julie\@example com", "text" "project update a new project plan has been published om http //example com/s/l ", "markdown" " project update a new project plan has been published on \<http //box com/s/lf ", "html" "\<p>\<strong>project update\</strong> a new project plan has been published \<a href ", "files" \[], "personid" "y2lzy29zcgfyazovl3vzl1bft1bmrs9mnwiznje4ny1jogrkltq3mjctogiyzi1mowm0nddmmjkwndy", "personemail" "matt\@example com", "mentionedpeople" \[], "mentionedgroups" \[], "attachments" \[] } } ] delete a message deletes a specific message in cisco webex using the provided message id endpoint url /v1/messages/{{messageid}} method delete input argument name type required description messageid string required the unique identifier for the message output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 204, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw 67bab0bf 352a 4f98 a9e1 aa84ee352d0a, routergw 67bab0bf 352a 4f98 a9e1 ", "date" "tue, 24 sep 2024 10 30 00 gmt", "x envoy upstream service time" "172", "vary" "origin", "server" "istio envoy" }, "reason" "no content", "response text" "" } ] edit a message update a previously posted message in cisco webex by specifying the messageid and roomid, limited to 10 edits endpoint url /v1/messages/{{messageid}} method put input argument name type required description messageid string required the unique identifier for the message roomid string required the room id of the message text string optional the message, in plain text if markdown is specified this parameter may be optionally used to provide alternate text for ui clients that do not support rich text the maximum message length is 7439 bytes markdown string optional the message, in markdown format if this attribute is set ensure that the request does not contain an html attribute html string optional the message, in html format the maximum message length is 7439 bytes output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier parentid string unique identifier roomid string unique identifier roomtype string type of the resource text string output field text markdown string output field markdown html string output field html files array output field files personid string unique identifier personemail string output field personemail mentionedpeople array output field mentionedpeople mentionedgroups array output field mentionedgroups attachments array output field attachments contenttype string type of the resource content object response content type string type of the resource version string output field version body array request body data type string type of the resource text string output field text size string output field size actions array output field actions type string type of the resource example \[ { "status code" 200, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw 9dbc4c33 6c55 4667 9ed0 3ccaf178dc44, routergw 9dbc4c33 6c55 4667 9ed0 ", "date" "tue, 24 sep 2024 10 14 04 gmt", "x envoy upstream service time" "359", "vary" "origin,accept encoding", "content encoding" "gzip", "content type" "application/json", "server" "istio envoy", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "id" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "parentid" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "roomid" "y2lzy29zcgfyazovl3vzl1jpt00vymjjzwixywqtndnmms0zyju4ltkxndctzje0ymiwyzrkmtu0", "roomtype" "group", "text" "project update a new project plan has been published on http //example com/s/l ", "markdown" " project update a new project plan has been published on \<http //example com/ ", "html" "\<p>\<strong>project update\</strong> a new project plan has been published \<a href ", "files" \[], "personid" "y2lzy29zcgfyazovl3vzl1bft1bmrs9mnwiznje4ny1jogrkltq3mjctogiyzi1mowm0nddmmjkwndy", "personemail" "matt\@example com", "mentionedpeople" \[], "mentionedgroups" \[], "attachments" \[], "created" "2015 10 18t14 26 16+00 00", "updated" "2015 10 18t14 27 16+00 00" } } ] get message details retrieve detailed information for a specific message in cisco webex using the provided message id endpoint url /v1/messages/{{messageid}} method get input argument name type required description messageid string required the unique identifier for the message output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier parentid string unique identifier roomid string unique identifier roomtype string type of the resource text string output field text markdown string output field markdown html string output field html files array output field files personid string unique identifier personemail string output field personemail mentionedpeople array output field mentionedpeople mentionedgroups array output field mentionedgroups attachments array output field attachments contenttype string type of the resource content object response content type string type of the resource version string output field version body array request body data type string type of the resource text string output field text size string output field size actions array output field actions type string type of the resource example \[ { "status code" 200, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw 0534d02d fc2a 4455 9930 4a1cf490c5c7, routergw 0534d02d fc2a 4455 9930 ", "cache control" "no cache, no store,no cache, no store", "date" "tue, 24 sep 2024 10 16 48 gmt", "x envoy upstream service time" "194", "vary" "origin,accept encoding", "content encoding" "gzip", "content type" "application/json", "server" "istio envoy", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "id" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "parentid" "y2lzy29zcgfyazovl3vzl01fu1nbr0uvotjkyjniztatndnizc0xmwu2lthhztktzgq1yjnkzmm1njvk", "roomid" "y2lzy29zcgfyazovl3vzl1jpt00vymjjzwixywqtndnmms0zyju4ltkxndctzje0ymiwyzrkmtu0", "roomtype" "group", "text" "project update a new project plan has been published on http //example com/s/l ", "markdown" " project update a new project plan has been published on \<http //example com/ ", "html" "\<p>\<strong>project update\</strong> a new project plan has been published \<a href ", "files" \[], "personid" "y2lzy29zcgfyazovl3vzl1bft1bmrs9mnwiznje4ny1jogrkltq3mjctogiyzi1mowm0nddmmjkwndy", "personemail" "matt\@example com", "mentionedpeople" \[], "mentionedgroups" \[], "attachments" \[], "created" "2015 10 18t14 26 16+00 00", "updated" "2015 10 18t14 27 16+00 00" } } ] list direct messages retrieves a sorted list of all messages from a specified 1 1 cisco webex room, including content attachments, using personid or personemail endpoint url /v1/messages/direct method get input argument name type required description parentid string optional list messages with a parent, by id personid string optional list messages in a 1 1 room, by person id personemail string optional list messages in a 1 1 room, by person email output parameter type description status code number http status code of the response reason string response reason phrase items array output field items id string unique identifier parentid string unique identifier roomid string unique identifier roomtype string type of the resource text string output field text markdown string output field markdown html string output field html files array output field files personid string unique identifier personemail string output field personemail attachments array output field attachments contenttype string type of the resource content object response content type string type of the resource version string output field version body array request body data type string type of the resource text string output field text size string output field size actions array output field actions type string type of the resource url string url endpoint for the request example \[ { "status code" 200, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw 0534d02d fc2a 4455 9930 4a1cf490c5c7, routergw 0534d02d fc2a 4455 9930 ", "cache control" "no cache, no store,no cache, no store", "date" "tue, 24 sep 2024 10 16 48 gmt", "x envoy upstream service time" "194", "vary" "origin,accept encoding", "content encoding" "gzip", "content type" "application/json", "server" "istio envoy", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "items" \[] } } ] list messages retrieves all messages from a specified cisco webex room, including content and attachments, identified by the roomid parameter endpoint url /v1/messages method get input argument name type required description roomid string required list messages in a room, by id parentid string optional list messages with a parent, by id mentionedpeople string optional list messages with these people mentioned, by id use me as a shorthand for the current api user only me or the person id of the current user may be specified bots must include this parameter to list messages in group rooms (spaces) before string optional list messages sent before a date and time beforemessage string optional list messages sent before a message, by id max number optional limit the maximum number of messages in the response cannot exceed 100 if used with mentionedpeople output parameter type description status code number http status code of the response reason string response reason phrase items array output field items id string unique identifier parentid string unique identifier roomid string unique identifier roomtype string type of the resource text string output field text markdown string output field markdown html string output field html files array output field files personid string unique identifier personemail string output field personemail mentionedpeople array output field mentionedpeople mentionedgroups array output field mentionedgroups attachments array output field attachments contenttype string type of the resource content object response content type string type of the resource version string output field version body array request body data type string type of the resource text string output field text size string output field size actions array output field actions example \[ { "status code" 200, "response headers" { "x content type options" "nosniff, nosniff", "trackingid" "routergw 00d9b2da 1859 4b7b b6a9 b8cdd1a10c2f, routergw 00d9b2da 1859 4b7b b6a9 ", "cache control" "no cache, no store,no cache, no store", "date" "tue, 24 sep 2024 10 26 49 gmt", "x envoy upstream service time" "220", "vary" "origin,accept encoding", "content encoding" "gzip", "content type" "application/json", "server" "istio envoy", "transfer encoding" "chunked" }, "reason" "ok", "json body" { "items" \[] } } ] response headers header description example cache control directives for caching mechanisms no cache, no store,no cache, no store content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated tue, 24 sep 2024 10 16 48 gmt server information about the software used by the origin server istio envoy trackingid http response header trackingid routergw 00d9b2da 1859 4b7b b6a9 b8cdd1a10c2f, routergw 00d9b2da 1859 4b7b b6a9 b8cdd1a10c2f transfer encoding http response header transfer encoding chunked vary http response header vary origin,accept encoding x content type options http response header x content type options nosniff, nosniff x envoy upstream service time http response header x envoy upstream service time 220 notes cisco webex authentication link https //developer webex com/docs/authenticationcisco webex api documentation https //developer webex com/docs/api/v1/messages the swimlane team will provide a python script and instructions on how to use the script to generate the access token and refresh token using oauth2 0