New Message Sent in Channel (Instant) from Mattermost API

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

Trigger workflow on

New Message Sent in Channel (Instant) from the Mattermost API

Next, do this

Connect to 2,000+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on New Message Sent in Channel (Instant) with Mattermost API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Message Sent in Channel (Instant) trigger
1. Connect your Mattermost account
2. Select a Team
3. Select a Channel
4. Optional- Configure Display Name
5. Configure Trigger Words
6. Optional- Select a Trigger When
Add steps to connect to 2,000+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Multiple Rows with Google Sheets API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + Google Sheets

Try it

Get Film with SWAPI - Star Wars API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + SWAPI - Star Wars

Try it

Send any HTTP Request with HTTP / Webhook API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + Ahrefs

Try it

[Date/Time] Add/Subtract Time with Formatting API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + Formatting

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.

New Message Sent in Channel (Instant) on Mattermost

Description:Emit new event when a message matching the requirements is sent in a channel. [See the documentation](https://api.mattermost.com/#tag/webhooks/operation/CreateOutgoingWebhook)

Version:0.0.2

Key:mattermost-new-message-sent-in-channel

View on GitHub

Code#

import mattermost from "../../app/mattermost.app.mjs";
import { defineSource, } from "@pipedream/types";
export default defineSource({
    name: "New Message Sent in Channel (Instant)",
    description: "Emit new event when a message matching the requirements is sent in a channel. [See the documentation](https://api.mattermost.com/#tag/webhooks/operation/CreateOutgoingWebhook)",
    key: "mattermost-new-message-sent-in-channel",
    version: "0.0.2",
    type: "source",
    dedupe: "unique",
    props: {
        mattermost,
        db: "$.service.db",
        http: "$.interface.http",
        teamId: {
            propDefinition: [
                mattermost,
                "teamId",
            ],
        },
        channelId: {
            propDefinition: [
                mattermost,
                "publicChannelId",
                ({ teamId }) => ({
                    teamId,
                }),
            ],
        },
        displayName: {
            type: "string",
            label: "Display Name",
            description: "The display name of the webhook in Mattermost",
            optional: true,
            default: "Pipedream source",
        },
        triggerWords: {
            type: "string[]",
            label: "Trigger Words",
            description: "List of words that will trigger an event",
        },
        triggerWhen: {
            type: "integer",
            label: "Trigger When",
            description: "When to trigger an event",
            optional: true,
            options: [
                {
                    label: "When a trigger word is present in the message",
                    value: 0,
                },
                {
                    label: "If the message starts with a trigger word",
                    value: 1,
                },
            ],
        },
    },
    methods: {
        _getWebhookId() {
            return this.db.get("webhookId");
        },
        _setWebhookId(value) {
            this.db.set("webhookId", value);
        },
    },
    hooks: {
        async activate() {
            const data = {
                team_id: this.teamId,
                channel_id: this.channelId,
                display_name: this.displayName,
                description: `Pipedream - New Message Sent in Channel ${this.channelId}`,
                trigger_words: this.triggerWords,
                trigger_when: this.triggerWhen,
                callback_urls: [
                    this.http.endpoint,
                ],
                content_type: "application/json",
            };
            const { id } = await this.mattermost.createWebhook(data);
            this._setWebhookId(id);
        },
        async deactivate() {
            const id = this._getWebhookId();
            await this.mattermost.deleteWebhook(id);
        },
    },
    async run({ body }) {
        if (body) {
            const ts = Date.now();
            this.$emit(body, {
                id: typeof body.id === "string"
                    ? body.id
                    : ts,
                summary: "New message",
                ts,
            });
        }
    },
});

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
Mattermost	`mattermost`	`app`	This component uses the Mattermost app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Team	`teamId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.
Display Name	`displayName`	`string`	The display name of the webhook in Mattermost
Trigger Words	`triggerWords`	`string[]`	List of words that will trigger an event
Trigger When	`triggerWhen`	`integer`	Select a value from the drop down menu:`{ "label": "When a trigger word is present in the message", "value": 0 }{ "label": "If the message starts with a trigger word", "value": 1 }`

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: