Create Message with Cisco Webex API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Create Message 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#

This integration creates a workflow with a Schedule trigger and Cisco Webex action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Message action
1. Connect your Cisco Webex account
2. Configure Text
3. Optional- Configure Markdown
4. Optional- Configure Person ID
5. Optional- Configure To Person Email
6. Optional- Select a Room ID
7. Optional- Select a Parent ID
8. Optional- Configure File
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Message on Cisco Webex

Description:Post a plain text or [rich text](https://developer.webex.com/docs/basics#formatting-messages) message, and optionally, a [file attachment](https://developer.webex.com/docs/basics#message-attachments), to a room. [See the docs here](https://developer.webex.com/docs/api/v1/messages/create-a-message)

Version:0.1.0

Key:cisco_webex-create-message

View on GitHub

Cisco Webex Overview#

The Cisco Webex API allows developers to integrate their applications with Cisco's robust collaboration tools, creating a workflow of communication within teams and automating various aspects of the meeting lifecycle, from scheduling to follow-up actions. With this API, you can streamline meeting setups, fetch detailed information about participants and meetings, send messages to spaces (rooms), and manage your Webex resources programmatically. Leveraging Pipedream's capabilities, you can connect these features with other apps to automate complex tasks, analyze meeting data, enhance productivity, and maintain a well-organized communication ecosystem.

Action Code#

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

export default {
  key: "cisco_webex-create-message",
  name: "Create Message",
  description: "Post a plain text or [rich text](https://developer.webex.com/docs/basics#formatting-messages) message, and optionally, a [file attachment](https://developer.webex.com/docs/basics#message-attachments), to a room. [See the docs here](https://developer.webex.com/docs/api/v1/messages/create-a-message)",
  type: "action",
  version: "0.1.0",
  props: {
    ciscoWebex,
    text: {
      type: "string",
      label: "Text",
      description: "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: {
      type: "string",
      label: "Markdown",
      description: "The message, in Markdown format. The maximum message length is 7439 bytes.",
      optional: true,
    },
    toPersonId: {
      propDefinition: [
        ciscoWebex,
        "personId",
      ],
      optional: true,
    },
    toPersonEmail: {
      type: "string",
      label: "To Person Email",
      description: "The email address of the recipient when sending a private 1:1 message.",
      optional: true,
    },
    roomId: {
      optional: true,
      propDefinition: [
        ciscoWebex,
        "roomId",
      ],
    },
    parentId: {
      optional: true,
      propDefinition: [
        ciscoWebex,
        "messageId",
        ({ roomId }) => ({
          roomId,
        }),
      ],
    },
    file: {
      type: "string",
      label: "File",
      description: "The public URL to a binary file to be posted into the room. (E.g. `http://www.example.com/images/media.png`)",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      roomId,
      parentId,
      toPersonId,
      toPersonEmail,
      text,
      markdown,
      file,
    } = this;

    const files = file && [
      file,
    ] || undefined;

    const response =
      await this.ciscoWebex.createMessage({
        data: {
          roomId,
          parentId,
          toPersonId,
          toPersonEmail,
          text,
          markdown,
          files,
        },
      });

    $.export("$summary", `Successfully posted message with ID ${response.id}`);

    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Cisco Webex	`ciscoWebex`	`app`	This component uses the Cisco Webex app.
Text	`text`	`string`	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	`markdown`	`string`	The message, in Markdown format. The maximum message length is 7439 bytes.
Person ID	`toPersonId`	`string`	The person ID of the recipient when sending a private 1:1 message.
To Person Email	`toPersonEmail`	`string`	The email address of the recipient when sending a private 1:1 message.
Room ID	`roomId`	`string`	Select a value from the drop down menu.
Parent ID	`parentId`	`string`	Select a value from the drop down menu.
File	`file`	`string`	The public URL to a binary file to be posted into the room. (E.g. `http://www.example.com/images/media.png`)

Action 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