Validate Webhook Auth with HTTP / Webhook API on New Message Sent in Channel (Instant) from Mattermost API

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

Trigger workflow on

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

Next, do this

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

Select this integration
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
Configure the Validate Webhook Auth action
1. Connect your HTTP / Webhook account
2. Configure Authorization Value to Authenticate
3. Configure Return Error to Webhook Caller
4. Select a Authorization Type
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#

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

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.

Trigger 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,
            });
        }
    },
});

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
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 }`

Trigger 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:

About Mattermost#

Open-source, self-hostable online chat service

Action#

Validate Webhook Auth on HTTP / Webhook

Description:Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to "Return a custom response from your workflow".

Version:0.0.3

Key:http-validate-webhook-auth

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Action Code#

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

export default {
  name: "Validate Webhook Auth",
  version: "0.0.3",
  key: "http-validate-webhook-auth",
  description: "Require authorization for incoming HTTP webhook requests. Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\".",
  type: "action",
  props: {
    http,
    authInput: {
      type: "string",
      label: "Authorization Value to Authenticate",
      description: "Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.",
      default: "{{steps.trigger.event.headers.authorization}}",
    },
    customResponse: {
      type: "boolean",
      label: "Return Error to Webhook Caller",
      description: "If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. **Make sure to configure the HTTP trigger to \"Return a custom response from your workflow\"**. If `False`, does not return a custom response in the case of invalid auth.",
      default: true,
    },
    authType: {
      type: "string",
      label: "Authorization Type",
      description: "Select the Authorization Type for the incoming webhook.",
      reloadProps: true,
      options: [
        {
          label: "Basic Auth",
          value: "basic",
        },
        {
          label: "Bearer Auth",
          value: "bearer",
        },
        {
          label: "Key-Based Auth",
          value: "key",
        },
      ],
    },
  },
  async additionalProps() {
    const props = {};
    switch (this.authType) {
    case "basic":
      props.basicAuthUsername = {
        type: "string",
        label: "Username",
        description: "Enter your username or reference an environment variable. For example, `{{process.env.username}}`.",
      };
      props.basicAuthPassword = {
        type: "string",
        label: "Password",
        description: "Enter your password or reference an environment variable. For example, `{{process.env.password}}`.",
        secret: true,
      };
      break;
    case "bearer":
      props.bearer = {
        type: "string",
        label: "Bearer Token",
        description: "Enter your Bearer Token  or reference an environment variable. For example, `{{process.env.token}}`. **Make sure to include any prepended values**, like `Bearer` for example.",
      };
      break;
    case "key":
      props.key = {
        type: "string",
        label: "API Key",
        description: "Enter your API Key or reference an environment variable. For example, `{{process.env.api_key}}`.",
        secret: true,
      };
      break;
    default:
    }
    return props;
  },
  async run({ $ }) {
    const authType = this.authType;
    const authInput = this.authInput;
    let basicString = "";
    if (authType === "basic") {
      const un = this.basicAuthUsername;
      const pw = this.basicAuthPassword;
      const str = `${un}:${pw}`;
      const buff = Buffer.from(str, "utf-8");
      basicString = `Basic ${buff.toString("base64")}`;
    }
    const authValue = this.bearer ?? this.key ?? basicString;
    if (authInput !== authValue) {
      if (this.customResponse) {
        await $.respond({
          status: 401,
          headers: {},
          body: "Invalid credentials",
        });
      }
      return $.flow.exit("Invalid credentials");
    }
    $.export("$summary", "HTTP request successfully authenticated");
  },
};

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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Authorization Value to Authenticate	`authInput`	`string`	Select the location of the authorization value to check. For example, if you're looking for a Bearer token on the inbound webhook request, set this to `{{steps.trigger.event.body.headers.authorization}}`.
Return Error to Webhook Caller	`customResponse`	`boolean`	If `True`, returns a `401: Invalid credentials` error in the case of invalid authorization. Make sure to configure the HTTP trigger to "Return a custom response from your workflow". If `False`, does not return a custom response in the case of invalid auth.
Authorization Type	`authType`	`string`	Select a value from the drop down menu:`{ "label": "Basic Auth", "value": "basic" }{ "label": "Bearer Auth", "value": "bearer" }{ "label": "Key-Based Auth", "value": "key" }`

Action Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

More Ways to Connect HTTP / Webhook + Mattermost#

Other Popular Integrations#

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

Mattermost + HTTP / Webhook

Try it

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

Mattermost + HTTP / Webhook

Try it

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

Mattermost + HTTP / Webhook

Try it

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

Mattermost + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New Message Sent in Channel (Instant) from Mattermost API

Mattermost + HTTP / Webhook

Try it

Popular Triggers#

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

Emit new event when a message matching the requirements is sent in a channel. See the documentation

Try it

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it