Connectors Reference
Webex Teams enables continuous teamwork with video meetings, group messaging, file sharing, and white boarding. Always available. Cisco secure. With the Webex Teams connector, you can send and receive messages, manage files, and manage spaces and teams.
|
Status: Preview |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
CreateSpaceMember ([Optional]CreateSpaceMemberParameterBody body) |
Add Member to Space |
|
Get Messages |
|
|
Send a Message |
|
|
Get Message Details |
|
|
Get People |
|
|
Get My Own Details |
|
|
GetSpaces ([Optional]integer max, [Optional]string type, [Optional]string sortBy) |
Get Spaces List |
|
Create Space |
|
|
Get Space Details |
|
|
CreateTeamMember ([Optional]CreateTeamMemberParameterBody body) |
Add Member to Team |
|
Get Teams |
|
Name |
Summary |
|
When a membership is updated |
|
|
When a membership is deleted |
|
|
When a membership is created |
|
|
When a message is created |
|
|
When a message is deleted |
|
|
When a space is created |
|
|
When a space is updated |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Add Member to Space
Description: Add a member to an existing space
Syntax:
WebexTeams.CreateSpaceMember ([Optional]CreateSpaceMemberParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
CreateSpaceMemberParameterBody
|
|
False |
Returns:
Type:CreateSpaceMemberResponse
Summary: Get Messages
Description: Get a list of recent messages for a space
Syntax:
WebexTeams.GetMessages (string roomId, [Optional]string mentionedPeople, [Optional]string beforeMessage, [Optional]string before, [Optional]integer max)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
roomId |
string (Space) |
List messages in a space for a given space ID |
True |
|
|
mentionedPeople |
string (Mentioned People) |
List messages where the caller is mentioned by specifying "me" or the caller personId. |
False |
|
|
beforeMessage |
string (Before Message) |
List messages sent before a message, by ID. |
False |
|
|
before |
string (Before) |
List messages sent before a date and time, in ISO8601 format. |
False |
|
|
max |
integer (Max) |
Limit the maximum number of messages in the response. |
False |
Returns:
Type:GetMessagesResponse
Summary: Send a Message
Description: Send a message to webex teams
Syntax:
WebexTeams.SendMessage (SendMessageParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:SendMessageResponse
Summary: Get Message Details
Description: Shows details for a message, by message ID.
Syntax:
WebexTeams.GetMessageDetails (string messageId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
messageId |
string (Message ID) |
The message ID |
True |
Returns:
Type:GetMessageDetailsResponse
Summary: Get People
Description: Lookup details and presence information for people in your organization
Syntax:
WebexTeams.GetPeople ([Optional]string id, [Optional]string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Person ID) |
List people by ID. Accepts up to 85 person IDs separated by commas. |
False |
|
|
|
string (Email) |
List people with this email address |
False |
Returns:
Type:GetPeopleResponse
Summary: Get My Own Details
Description: Lookup your own details
Syntax:
WebexTeams.GetMyOwnDetails ()
Returns:
Summary: Get Spaces List
Description: This action retrieves a list of spaces
Syntax:
WebexTeams.GetSpaces ([Optional]integer max, [Optional]string type, [Optional]string sortBy)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
max |
integer (Max Results) |
Maximum number of spaces to return |
False |
|
|
type |
string (Type of space)Values: [group, direct] |
(group) only include group spaces, (direct) only include 1 to 1 spaces, returns all if not specified |
False |
|
|
sortBy |
string (Sort By)Values: [lastactivity, created] |
(id) the space id, (lastactivity) the last activity timestamp, (created) space creation date |
False |
Returns:
Type:GetSpacesResponse
Summary: Create Space
Description: Create space or team space
Syntax:
WebexTeams.CreateSpace (CreateSpaceParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:CreateSpaceResponse
Summary: Get Space Details
Description: Return details of a given space
Syntax:
WebexTeams.GetSpaceDetail (string roomId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
roomId |
string (Space) |
Select a space |
True |
Returns:
Summary: Add Member to Team
Description: Add a member to a team
Syntax:
WebexTeams.CreateTeamMember ([Optional]CreateTeamMemberParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Summary: Get Teams
Description: Get a list of teams you belong to
Syntax:
WebexTeams.GetTeams ([Optional]integer max)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
max |
integer
|
Max number of teams to return |
False |
Returns:
Type:GetTeamsResponse
Summary: When a membership is updated
Description: Someone's membership was updated in a room that you're in; primarily used to detect moderator changes
Syntax:
WebexTeams.MembershipsUpdated (MembershipsUpdatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
MembershipsUpdatedParameterBody
|
|
True |
Returns:
Type:MembershipsUpdatedResponse
Summary: When a membership is deleted
Description: Someone left or was kicked out of a room that you're in, or you left or were removed from a room; only triggers for group rooms, not 1-to-1 rooms
Syntax:
WebexTeams.MembershipsDeleted (MembershipsDeletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
MembershipsDeletedParameterBody
|
|
True |
Returns:
Type:MembershipsDeletedResponse
Summary: When a membership is created
Description: Someone joined a room that you're in or you've been added to a new room
Syntax:
WebexTeams.MembershipsCreated (MembershipsCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
MembershipsCreatedParameterBody
|
|
True |
Returns:
Type:MembershipsCreatedResponse
Summary: When a message is created
Description: New message posted into a room that you're in
Syntax:
WebexTeams.MessagesCreated (MessagesCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When a message is deleted
Description: A message was deleted from a room that you're in
Syntax:
WebexTeams.MessagesDeleted (MessagesDeletedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: When a space is created
Description: A new space was created by you or one of your integrations
Syntax:
WebexTeams.SpaceCreated (SpaceCreatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:SpaceCreatedResponse
Summary: When a space is updated
Description: A space that you're in was updated; primarily used to detect when a space becomes Locked or Unlocked
Syntax:
WebexTeams.SpaceUpdated (SpaceUpdatedParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:SpaceUpdatedResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
isModerator |
boolean
|
Is moderator? |
|
personEmail |
string
|
Email address |
|
personId |
string
|
Person ID of the new member |
|
roomId |
string
|
Select a space |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
isModerator |
boolean
|
isModerator |
|
isMonitor |
boolean
|
isMonitor |
|
personDisplayName |
string
|
personDisplayName |
|
personEmail |
string
|
personEmail |
|
personId |
string
|
personId |
|
personOrgId |
string
|
personOrgId |
|
roomId |
string
|
roomId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
teamId |
string
|
Optionally select a team |
|
title |
string
|
Space Title |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
creatorId |
string
|
creatorId |
|
id |
string
|
id |
|
isLocked |
boolean
|
isLocked |
|
lastActivity |
string(date-time)
|
lastActivity |
|
title |
string
|
title |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
isModerator |
boolean
|
Is Moderator? |
|
personEmail |
string
|
Email address |
|
personId |
string
|
Person ID of the new member |
|
teamId |
string
|
Select a team |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
isModerator |
boolean
|
isModerator |
|
personDisplayName |
string
|
personDisplayName |
|
personEmail |
string
|
personEmail |
|
personId |
string
|
personId |
|
personOrgId |
string
|
personOrgId |
|
teamId |
string
|
teamId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string
|
created |
|
files |
array of (string)
|
files |
|
id |
string
|
id |
|
markdown |
string
|
markdown |
|
mentionedGroups |
array of (string)
|
mentionedGroups |
|
mentionedPeople |
array of (string)
|
mentionedPeople |
|
personEmail |
string
|
personEmail |
|
personId |
string
|
personId |
|
roomId |
string
|
roomId |
|
roomType |
string
|
roomType |
|
text |
string
|
text |
|
toPersonEmail |
string
|
toPersonEmail |
|
toPersonId |
string
|
toPersonId |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
personEmail |
string
|
personEmail |
|
personId |
string
|
personId |
|
roomId |
string
|
roomId |
|
roomType |
string
|
roomType |
|
text |
string
|
text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
avatar |
string
|
avatar |
|
created |
string
|
created |
|
displayName |
string
|
displayName |
|
emails |
array of (string)
|
emails |
|
firstName |
string
|
firstName |
|
id |
string
|
id |
|
lastActivity |
string
|
lastActivity |
|
lastName |
string
|
lastName |
|
nickName |
string
|
nickName |
|
orgId |
string
|
orgId |
|
phoneNumbers |
array of (PhoneNumbersItem)
|
phoneNumbers |
|
status |
string
|
status |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
value |
string
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (ItemsItem)
|
items |
|
notFoundIds |
array of (string)
|
notFoundIds |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
avatar |
string
|
avatar |
|
created |
string
|
created |
|
displayName |
string
|
displayName |
|
emails |
array of (string)
|
emails |
|
firstName |
string
|
firstName |
|
id |
string
|
id |
|
lastActivity |
string
|
lastActivity |
|
lastName |
string
|
lastName |
|
nickName |
string
|
nickName |
|
orgId |
string
|
orgId |
|
phoneNumbers |
array of (PhoneNumbersItem)
|
phoneNumbers |
|
status |
string
|
status |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
type |
string
|
type |
|
value |
string
|
value |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
creatorId |
string
|
creatorId |
|
id |
string
|
id |
|
isLocked |
boolean
|
isLocked |
|
lastActivity |
string(date-time)
|
lastActivity |
|
title |
string
|
title |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
creatorId |
string
|
creatorId |
|
id |
string
|
id |
|
isLocked |
boolean
|
isLocked |
|
lastActivity |
string(date-time)
|
lastActivity |
|
title |
string
|
title |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (ItemsItem)
|
items |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
creatorId |
string
|
creatorId |
|
id |
string
|
id |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
files |
array of (string)
|
files |
|
markdown |
string
|
Message, in markdown format |
|
roomId |
string
|
Select a recipient space |
|
text |
string
|
Message Text, in plain text, used for clients that do not support markdown |
|
toPersonEmail |
string
|
The email address of the recipient when sending a private 1:1 message |
|
toPersonId |
string
|
The ID of the recipient when sending a 1:1 message |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
personEmail |
string
|
personEmail |
|
personId |
string
|
personId |
|
roomId |
string
|
roomId |
|
roomType |
string
|
roomType |
|
text |
string
|
text |
|
toPersonEmail |
string
|
toPersonEmail |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
event |
string
|
event |
|
name |
string
|
name |
|
resource |
string
|
resource |
|
targetUrl |
string
|
targetUrl |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
created |
string(date-time)
|
created |
|
id |
string
|
id |
|
name |
string
|
name |
|
targetUrl |
string
|
targetUrl |
|
resource |
string
|
resource |
|
event |
string
|
event |
|
filter |
string
|
filter |
|
secret |
string
|
secret |
|
status |
string
|
status |