Webex

Create and list meetings in Cisco Webex.

CommunicationAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
createMessage
createRoom
createTeam
findMessage
findRoom
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("webex", "createMessage", {
    "messageType": "room",
    "destination": {},
    "text": "<message text>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Webex answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "webex-createmessage",
  name: "Webex: Create Message",
  description: "Calls Webex when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("webex", {
      "action": "createMessage",
      "messageType": "room",
      "destination": {},
      "text": "<message text>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/webex/createMessage" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"messageType":"room","destination":{},"text":"<message text>"}}'

Actions

createMessagein catalog

Create Message. Post a plain text or rich text message to a Webex room or send a direct message

Input	Type	Description
`messageType`required	one of "room" \| "direct"	Choose between sending to a room or a direct message to a person
`destination`required	object (depends on other props)	Destination
`text`required	long text	The message to send
`markdown`optional	long text	The message in Markdown format for rich text. If provided, text will be used as alternate text
`parentId`optional	text	The parent message ID to reply to (optional)
`files`optional	array	Public URLs to files to attach (only one file per message)

createRoomin catalog

Create Room. Create a new Webex room (space). The authenticated user is automatically added as a member.

Input	Type	Description
`title`required	text	A user-friendly name for the room
`description`optional	long text	The description of the room. Required if isPublic is true.
`teamId`optional	text	The ID for the team with which this room is associated (optional)
`classificationId`optional	text	The classificationId for the room (optional)
`isPublic`optional	boolean	Make the room public and discoverable within the org. Note: description is required if this is true.
`isLocked`optional	boolean	Set the space as locked/moderated. The creator becomes a moderator.
`isAnnouncementOnly`optional	boolean	Sets the space into announcement mode. Only moderators can post messages. Note: space must be locked (moderated) to enable this.

createTeamin catalog

Create Team. Create a new Webex team. The authenticated user is automatically added as a member.

Input	Type	Description
`name`required	text	A user-friendly name for the team
`description`optional	long text	The description of the team (optional)

findMessagein catalog

Find Message. Retrieve details for a specific message by message ID

Input	Type	Description
`messageId`required	text	The unique identifier for the message

findRoomin catalog

Find room. Retrieve details for a specific room by room id

Input	Type	Description
`roomId`required	text	Room Id

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: webex
Category: Communication
Tags: video, meetings, conferencing, cisco
Package: @activepieces/piece-webex@0.0.1
Tier: Community