Post Message with Mattermost API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Post Message with the Mattermost 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 Mattermost action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Post Message action
1. Connect your Mattermost account
2. Select a Channel
3. Configure Message
4. Optional- Configure Root ID
5. Optional- Configure File IDs
6. Optional- Configure Props
7. Optional- Configure Set Online
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#

Monthly Schedule on Schedule

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

Version:0.0.2

Key:schedule-monthly

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: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month 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#

Post Message on Mattermost

Description:Create a new post in a channel [See docs here](https://api.mattermost.com/#tag/posts/operation/CreatePost)

Version:0.0.3

Key:mattermost-post-message

View on GitHub

Mattermost Overview#

Mattermost is an open-source platform for secure collaboration across the entire software development lifecycle. With the Mattermost API on Pipedream, you can automate common chat operations, integrate with DevOps tools for real-time alerts, orchestrate workflows based on chat events, and connect with other services to enhance team productivity. For instance, you could trigger actions on issue tracking platforms when discussing bugs or link project management tools to update task statuses directly from your Mattermost channels.

Action Code#

import mattermost from "../../app/mattermost.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Post Message",
    description: "Create a new post in a channel [See docs here](https://api.mattermost.com/#tag/posts/operation/CreatePost)",
    key: "mattermost-post-message",
    version: "0.0.3",
    type: "action",
    props: {
        mattermost,
        channelId: {
            propDefinition: [
                mattermost,
                "channelId",
            ],
        },
        message: {
            label: "Message",
            description: "The message contents, can be formatted with Markdown.",
            type: "string",
        },
        rootId: {
            label: "Root ID",
            description: "The post ID to comment on. You can use the ID of a previously created post, or get it by copying the link to a post on Mattermost's interface.",
            type: "string",
            optional: true,
        },
        fileIds: {
            label: "File IDs",
            description: "A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.",
            type: "string[]",
            optional: true,
        },
        postProps: {
            label: "Props",
            description: "A general JSON property bag to attach to the post.",
            type: "object",
            optional: true,
        },
        setOnline: {
            label: "Set Online",
            description: "Whether to set the user status as online or not.",
            type: "boolean",
            optional: true,
        },
    },
    async run({ $ }) {
        const params = {
            $,
            data: {
                channel_id: this.channelId,
                message: this.message,
                root_id: this.rootId,
                file_ids: this.fileIds,
                props: this.postProps,
            },
            params: {
                set_online: this.setOnline,
            },
        };
        const data = await this.mattermost.postMessage(params);
        $.export("$summary", `Successfully posted message (id ${data.id})`);
        return data;
    },
});

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
Mattermost	`mattermost`	`app`	This component uses the Mattermost app.
Channel	`channelId`	`string`	Select a value from the drop down menu.
Message	`message`	`string`	The message contents, can be formatted with Markdown.
Root ID	`rootId`	`string`	The post ID to comment on. You can use the ID of a previously created post, or get it by copying the link to a post on Mattermost's interface.
File IDs	`fileIds`	`string[]`	A list of file IDs to associate with the post. Note that posts are limited to 5 files maximum. Please use additional posts for more files.
Props	`postProps`	`object`	A general JSON property bag to attach to the post.
Set Online	`setOnline`	`boolean`	Whether to set the user status as online or not.

Action Authentication#

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

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