Skip to main content

Cisco Webex Teams

This Integration is part of the Cisco Webex Teams Pack.#

Send messages, create rooms and more, via the Cisco Spark API. This integration was integrated and tested with version 6.2.0 of Cisco Spark

Configure Cisco Webex Teams on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Cisco Webex Teams.

  3. Click Add instance to create and configure a new integration instance.

    ParameterRequired
    Server URL (e.g. https://192.168.0.1)True
    API KeyTrue
    Trust any certificate (not secure)False
    Use system proxy settingsFalse
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

cisco-spark-list-people#


List people

Base Command#

cisco-spark-list-people

Input#

Argument NameDescriptionRequired
emailList people with this email address. For non-admin requests, either this or displayName are required.Optional
displayNameList people whose name starts with this string. For non-admin requests, either this or email are required.Optional
orgIdList people in this organization. Only admin users of another organization (such as partners) may use this parameter.Optional
maxLimit the maximum number of people in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.PeopleunknownThe list of people.

cisco-spark-create-person#


Create a new user account for a given organization. Only an admin can create a new user account.

Base Command#

cisco-spark-create-person

Input#

Argument NameDescriptionRequired
emailsEmail addresses of the person (comma separated).Optional
displayNameFull name of the person.Optional
firstNameFirst name of the person.Optional
lastNameLast name of the person.Optional
avatarURL to the person's avatar in PNG format.Optional
orgIdID of the organization to which this person belongs.Optional
rolesRoles of the person (comma separated).Optional
licensesLicenses allocated to the person.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-person-details#


Shows details for a person, by ID.

Base Command#

cisco-spark-get-person-details

Input#

Argument NameDescriptionRequired
personIdThe person ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-person#


Update details for a person, by ID. Only an admin can update a person details.

Base Command#

cisco-spark-update-person

Input#

Argument NameDescriptionRequired
emailsEmail addresses of the person (comma separated).Optional
displayNameFull name of the person.Optional
firstNameFirst name of the person.Optional
lastNameLast name of the person.Optional
avatarURL to the person's avatar in PNG format.Optional
orgIdID of the organization to which this person belongs.Optional
rolesRoles of the person (comma separated).Optional
licensesLicenses allocated to the person (comma separated).Optional
personIdThe person ID.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-person#


Remove a person from the system. Only an admin can remove a person.

Base Command#

cisco-spark-delete-person

Input#

Argument NameDescriptionRequired
personIdThe person ID.Required

Context Output#

There is no context output for this command.

cisco-spark-get-own-details#


Show the profile for the authenticated user.

Base Command#

cisco-spark-get-own-details

Input#

Argument NameDescriptionRequired

Context Output#

There is no context output for this command.

cisco-spark-list-rooms#


List rooms.

Base Command#

cisco-spark-list-rooms

Input#

Argument NameDescriptionRequired
teamIdLimit the rooms to those associatedwith a team, by ID.Optional
maxLimit the maximum number of rooms in the response.Optional
typeAvailable values: direct and group. direct returns all 1-to-1 rooms. group returns all group rooms. If not specified or values not matched, will return all room types. Possible values are: direct, group.Optional

Context Output#

PathTypeDescription
CiscoSpark.RoomsunknownThe list of rooms.

cisco-spark-create-room#


Creates a room.

Base Command#

cisco-spark-create-room

Input#

Argument NameDescriptionRequired
titleA user-friendly name for the room.Required
teamIdThe ID for the team with which this room is associated.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-room-details#


Shows details for a room, by ID.

Base Command#

cisco-spark-get-room-details

Input#

Argument NameDescriptionRequired
roomIdThe room ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-room#


Updates details for a room, by ID.

Base Command#

cisco-spark-update-room

Input#

Argument NameDescriptionRequired
roomIdThe room ID.Required
titleA user-friendly name for the room.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-room#


Deletes a room, by ID. Deleted rooms cannot be recovered.

Base Command#

cisco-spark-delete-room

Input#

Argument NameDescriptionRequired
roomIdThe room ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-memberships#


Lists all room memberships. Use either personId or personEmail to filter the results.

Base Command#

cisco-spark-list-memberships

Input#

Argument NameDescriptionRequired
roomIdLimit results to a specific room, by ID.Optional
personIdLimit results to a specific person, by ID.Optional
personEmailLimit results to a specific person, by email address.Optional
maxLimit the maximum number of items in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.MembershipsunknownList of memberships.

cisco-spark-create-membership#


Add someone to a room by Person ID or email address; optionally making them a moderator.

Base Command#

cisco-spark-create-membership

Input#

Argument NameDescriptionRequired
roomIdThe room ID.Required
personIdThe person ID.Optional
personEmailThe email address of the person.Optional
isModeratorSet to true to make the person a room moderator. Possible values are: true, false.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-membership-details#


Get details for a membership by ID.

Base Command#

cisco-spark-get-membership-details

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-membership#


Updates properties for a membership by ID.

Base Command#

cisco-spark-update-membership

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required
isModeratorSet to true to make the person a room moderator. Possible values are: true, false.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-membership#


Deletes a membership by ID.

Base Command#

cisco-spark-delete-membership

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-messages#


Lists all messages in a room.

Base Command#

cisco-spark-list-messages

Input#

Argument NameDescriptionRequired
roomIdList messages for a room, by ID.Required
mentionedPeopleList messages where the caller is mentioned by specifying "me" or the caller personId.Optional
beforeList messages sent before a date and time, in ISO8601 format.Optional
beforeMessageList messages sent before a message, by ID.Optional
maxLimit the maximum number of messages in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.MessagesunknownList of messages, by roomId.

cisco-spark-create-message#


Posts a plain text message, and optionally, a media content attachment, to a room.

Base Command#

cisco-spark-create-message

Input#

Argument NameDescriptionRequired
roomIdThe room ID.Optional
toPersonIdThe ID of the recipient when sending a private 1:1 message.Optional
toPersonEmailThe email address of the recipient when sending a private 1:1 message.Optional
textThe message, in plain text. If markdown is specified this parameter may be optionally used to provide alternate text forUI clients that do not support rich text.Optional
markdownThe message, in markdown format.Optional
filesThe 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 Spark clients can render. For the supported media types and the behavior of uploads, see the Message AttachmentsGuide.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-message-details#


Shows details for a message, by message ID.

Base Command#

cisco-spark-get-message-details

Input#

Argument NameDescriptionRequired
messageIdThe message ID.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-message#


Deletes a message, by message ID.

Base Command#

cisco-spark-delete-message

Input#

Argument NameDescriptionRequired
messageIdThe message ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-teams#


Lists teams to which the authenticated user belongs.

Base Command#

cisco-spark-list-teams

Input#

Argument NameDescriptionRequired
maxLimit the maximum number of teams in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.TeamsunknownList of teams.

cisco-spark-create-team#


Creates a team. The authenticated user is automatically added as a member of the team.

Base Command#

cisco-spark-create-team

Input#

Argument NameDescriptionRequired
nameA user-friendly name for the team.Required

Context Output#

There is no context output for this command.

cisco-spark-get-team-details#


Shows details for a team, by ID.

Base Command#

cisco-spark-get-team-details

Input#

Argument NameDescriptionRequired
teamIdThe team ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-team#


Updates details for a team, by ID.

Base Command#

cisco-spark-update-team

Input#

Argument NameDescriptionRequired
teamIdThe team ID.Required
nameA user-friendly name for the team.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-team#


Deletes a team, by ID.

Base Command#

cisco-spark-delete-team

Input#

Argument NameDescriptionRequired
teamIdThe team ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-team-memberships#


Lists all team memberships for a given team, specified by the teamId query parameter.

Base Command#

cisco-spark-list-team-memberships

Input#

Argument NameDescriptionRequired
teamIdList team memberships for a team, by ID.Required
maxLimit the maximum number of items in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.TeamMembershipsunknownList of team memberships.

cisco-spark-create-team-membership#


Add someone to a team by Person ID or email address; optionally making them a moderator.

Base Command#

cisco-spark-create-team-membership

Input#

Argument NameDescriptionRequired
teamIdThe team ID.Required
personIdThe person ID.Optional
personEmailThe email address of the person.Optional
isModeratorSet to true to make the person a team moderator. Possible values are: true, false.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-team-membership-details#


Shows details for a team membership, by ID.

Base Command#

cisco-spark-get-team-membership-details

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-team-membership#


Updates a team membership, by ID.

Base Command#

cisco-spark-update-team-membership

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required
isModeratorSet to true to make the person a team moderator. Possible values are: true, false.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-team-membership#


Deletes a team membership, by ID.

Base Command#

cisco-spark-delete-team-membership

Input#

Argument NameDescriptionRequired
membershipIdThe membership ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-webhooks#


Lists all of your webhooks.

Base Command#

cisco-spark-list-webhooks

Input#

Argument NameDescriptionRequired
maxLimit the maximum number of webhooks in the response. Setting this to greater than 100 will return an error.Optional

Context Output#

PathTypeDescription
CiscoSpark.WebhooksunknownList of webhooks.

cisco-spark-create-webhook#


Creates a webhook.

Base Command#

cisco-spark-create-webhook

Input#

Argument NameDescriptionRequired
nameA user-friendly name for this webhook.Required
targetUrlThe URL that receives POST requests for each event.Required
resourceThe resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.Required
eventThe event type for the webhook.Required
filterThe filter that defines the webhook scope.Optional
secretSecret used to generate payload signature.Optional

Context Output#

There is no context output for this command.

cisco-spark-get-webhook-details#


Shows details for a webhook, by ID.

Base Command#

cisco-spark-get-webhook-details

Input#

Argument NameDescriptionRequired
webhookIdThe webhook ID.Required

Context Output#

There is no context output for this command.

cisco-spark-update-webhook#


Updates a webhook, by ID.

Base Command#

cisco-spark-update-webhook

Input#

Argument NameDescriptionRequired
webhookIdThe webhook ID.Required
nameA user-friendly name for this webhook.Required
targetUrlThe URL that receives POST requests for each event.Required

Context Output#

There is no context output for this command.

cisco-spark-delete-webhook#


Deletes a webhook, by ID.

Base Command#

cisco-spark-delete-webhook

Input#

Argument NameDescriptionRequired
webhookIdThe webhook ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-organizations#


List all organizations visible by your account.

Base Command#

cisco-spark-list-organizations

Input#

Argument NameDescriptionRequired
maxLimit the maximum number of entries in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.OrganizationsunknownList of organizations.

cisco-spark-get-organization-details#


Shows details for an organization, by ID.

Base Command#

cisco-spark-get-organization-details

Input#

Argument NameDescriptionRequired
orgIdThe organization ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-licenses#


List all licenses for a given organization. If no orgId is specified, the default is the organization of the authenticated user.

Base Command#

cisco-spark-list-licenses

Input#

Argument NameDescriptionRequired
orgIdSpecify the organization.Optional
maxLimit the maximum number of entries in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.LicensesunknownList of licenses.

cisco-spark-get-license-details#


Shows details for a license, by ID.

Base Command#

cisco-spark-get-license-details

Input#

Argument NameDescriptionRequired
licenseIdThe license ID.Required

Context Output#

There is no context output for this command.

cisco-spark-list-roles#


List all roles.

Base Command#

cisco-spark-list-roles

Input#

Argument NameDescriptionRequired
maxLimit the maximum number of entries in the response.Optional

Context Output#

PathTypeDescription
CiscoSpark.RolesunknownList of roles.

cisco-spark-get-role-details#


Shows details for a role, by ID.

Base Command#

cisco-spark-get-role-details

Input#

Argument NameDescriptionRequired
roleIdThe role ID.Required

Context Output#

There is no context output for this command.

cisco-spark-send-message-to-person#


Sends a message to a person, by email or person ID.

Base Command#

cisco-spark-send-message-to-person

Input#

Argument NameDescriptionRequired
toPersonEmailEmail address of the recipient.Optional
toPersonIdThe personId of the recipient.Optional
textThe message, in plain text. If markdown is specified this parameter may be optionally used to provide alternate text forUI clients that do not support rich text.Optional
markdownThe message, in markdown format.Optional
filesThe 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 Spark clients can render. For the supported media types and the behavior of uploads, see the Message AttachmentsGuide.Optional

Context Output#

There is no context output for this command.

cisco-spark-send-message-to-room#


Sends a message to a room, by name or room ID.

Base Command#

cisco-spark-send-message-to-room

Input#

Argument NameDescriptionRequired
toRoomNameThe room name.Optional
roomIdThe room ID.Optional
textThe message, in plain text. If markdown is specified this parameter may be optionally used to provide alternate text forUI clients that do not support rich text.Optional
markdownThe message, in markdown format.Optional
filesThe 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 Spark clients can render. For the supported media types and the behavior of uploads, see the Message AttachmentsGuide.Optional

Context Output#

There is no context output for this command.