List Messages with Cisco Webex API

Pipedream makes it easy to connect APIs for Cisco Webex and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Messages with the Cisco Webex API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List Messages with the Cisco Webex API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Messages action
1. Connect your Cisco Webex account
2. Select a Room ID
3. Optional- Select a Parent ID
4. Optional- Configure Before
5. Optional- Configure Max
6. Optional- Configure Max Resources
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List Messages with Cisco Webex API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Cisco Webex

Try it

List Messages with Cisco Webex API on New Item in Feed from RSS API

RSS + Cisco Webex

Try it

List Messages with Cisco Webex API on New Message from Discord API

Discord + Cisco Webex

Try it

List Messages with Cisco Webex API on New Message In Channels from Slack API

Slack + Cisco Webex

Try it

List Messages with Cisco Webex API on New Message in Channel from Discord Bot API

Discord Bot + Cisco Webex

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Messages on Cisco Webex

Description:Retrieve messages in a specific room. [See the docs here](https://developer.webex.com/docs/api/v1/messages/list-messages)

Version:0.1.0

Key:cisco_webex-list-messages

View on GitHub

Code#

import ciscoWebex from "../../cisco_webex.app.mjs";

export default {
  key: "cisco_webex-list-messages",
  name: "List Messages",
  description: "Retrieve messages in a specific room. [See the docs here](https://developer.webex.com/docs/api/v1/messages/list-messages)",
  type: "action",
  version: "0.1.0",
  props: {
    ciscoWebex,
    roomId: {
      propDefinition: [
        ciscoWebex,
        "roomId",
      ],
    },
    parentId: {
      propDefinition: [
        ciscoWebex,
        "messageId",
        ({ roomId }) => ({
          roomId,
        }),
      ],
      optional: true,
    },
    before: {
      type: "string",
      label: "Before",
      description: "List messages sent before a date and time.",
      optional: true,
    },
    max: {
      type: "integer",
      label: "Max",
      description: "The maximum number of messages to return per page. Defaults to `50`.",
      optional: true,
    },
    maxResources: {
      type: "integer",
      label: "Max Resources",
      description: "The maximum number of resources to return in total. Defaults to `100`.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      roomId,
      parentId,
      before,
      max,
      maxResources,
    } = this;

    const messages = [];

    const resourcesStream =
      await this.ciscoWebex.getResourcesStream({
        resourceFn: this.ciscoWebex.listMessages,
        resourceFnArgs: {
          $,
          params: {
            roomId,
            parentId,
            before,
            max,
          },
        },
        maxResources,
      });

    for await (const message of resourcesStream) {
      messages.push(message);
    }

    // eslint-disable-next-line multiline-ternary
    $.export("$summary", `Successfully fetched ${messages.length} ${messages.length === 1 ? "message" : "messages"}`);

    return messages;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Cisco Webex	`ciscoWebex`	`app`	This component uses the Cisco Webex app.
Room ID	`roomId`	`string`	Select a value from the drop down menu.
Parent ID	`parentId`	`string`	Select a value from the drop down menu.
Before	`before`	`string`	List messages sent before a date and time.
Max	`max`	`integer`	The maximum number of messages to return per page. Defaults to `50`.
Max Resources	`maxResources`	`integer`	The maximum number of resources to return in total. Defaults to `100`.

Authentication#

Cisco Webex uses OAuth authentication. When you connect your Cisco Webex account, Pipedream will open a popup window where you can sign into Cisco Webex and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Cisco Webex API.

Pipedream requests the following authorization scopes when you connect your account:

spark:allspark-admin:people_readspark-admin:people_writespark:devices_readspark:devices_write