← Mailgun

Create Route with Mailgun API

Pipedream makes it easy to connect APIs for Mailgun and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Route with the Mailgun API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the Create Route action
    1. Connect your Mailgun account
    2. Configure Priority
    3. Configure Description
    4. Select a Filter On
    5. Configure Filter Expression
    6. Select a Action
    7. Configure Action Expression
    8. Configure Halt on error?
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Route with Mailgun API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Create Route with Mailgun API on New Item in Feed from RSS API
RSS + Mailgun
 
Try it
Create Route with Mailgun API on New Message from Discord API
Discord + Mailgun
 
Try it
Create Route with Mailgun API on New Message In Channels from Slack API
Slack + Mailgun
 
Try it
Create Route with Mailgun API on New Message in Channel from Discord Bot API
Discord Bot + Mailgun
 
Try it

Details

This is a pre-built, open source 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.

Create Route on Mailgun
Description:Create a new route. [See the docs here](https://documentation.mailgun.com/en/latest/api-routes.html#actions)
Version:0.0.2
Key:mailgun-create-route

Code

import mailgun from "../../mailgun.app.mjs";
import common from "../common.mjs";

export default {
  key: "mailgun-create-route",
  name: "Create Route",
  description: "Create a new route. [See the docs here](https://documentation.mailgun.com/en/latest/api-routes.html#actions)",
  version: "0.0.2",
  type: "action",
  props: {
    mailgun,
    priority: {
      propDefinition: [
        mailgun,
        "priority",
      ],
    },
    description: {
      propDefinition: [
        mailgun,
        "description",
      ],
    },
    match: {
      type: "string",
      label: "Filter On",
      description: "For more information, see the [route filters API documentation]" +
        "(https://documentation.mailgun.com/en/latest/api-routes.html#filters)",
      options: [
        "recipient",
        "header",
        "catch_all",
      ],
    },
    matchExpression: {
      type: "string",
      label: "Filter Expression",
      description: "For the `recipient` filter, specify a regex expression like `.*@gmail.com`. " +
        "For the `header` filter, specify a header name followed by a colon followed by a regex, " +
        "like `subject:.*support`. For the `catch_all` filters, leave this blank.",
    },
    action: {
      type: "string",
      label: "Action",
      description: "The route action to execute when the route expression evaluates to True. For" +
        "more information, see the [route actions API documentation]" +
        "[https://documentation.mailgun.com/en/latest/api-routes.html#actions]",
      options: [
        "forward",
        "store",
        "stop",
      ],
    },
    action_expression: {
      type: "string",
      label: "Action Expression",
      description: "For the `forward` action, specify a destination email address or URL. " +
        "For the `store` action, (optionally) specify a webhook URL to notify. " +
        "For the `stop` action, leave this blank.",
    },
    ...common.props,
  },
  methods: {
    _expression (filter, expression) {
      switch (filter) {
      case "catch_all":
        return "catch_all()";
      case "recipient":
        return `match_recipient("${expression}")`;
      case "header": {
        let [
          header,
          headerExpression,
        ] = expression.split(":");
        if (Array.isArray(headerExpression)) {
          headerExpression = headerExpression.join(":");
        }
        return `match_header("${header}", "${headerExpression}")`;
      }
      default:
        throw new Error(`Unsupported filter: ${filter}`);
      }
    },
    _action (action, arg) {
      switch (action) {
      case "forward":
        return `forward("${arg}")`;
      case "store":
        if (arg.length > 0) {
          return `store(notify="${arg}")`;
        } else {
          return "store()";
        }
      case "stop":
        return "stop()";
      default:
        throw new Error(`Unsupported action: ${action}`);
      }
    },
    ...common.methods,
  },
  async run({ $ }) {
    const opts = {
      priority: this.priority,
      description: this.description,
      expression: this._expression(this.match, this.matchExpression),
      action: [
        this._action(this.action, this.action_expression),
      ],
    };
    const resp = await this.withErrorHandler(this.mailgun.createRoute, opts);
    $.export("$summary", "Successfully created route");
    return resp;
  },
};

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.
LabelPropTypeDescription
MailgunmailgunappThis component uses the Mailgun app.
Prioritypriorityinteger

Priority ranks low to high, and higher priority routes are handled first

Descriptiondescriptionstring
Filter OnmatchstringSelect a value from the drop down menu:recipientheadercatch_all
Filter ExpressionmatchExpressionstring

For the recipient filter, specify a regex expression like .*@gmail.com. For the header filter, specify a header name followed by a colon followed by a regex, like subject:.*support. For the catch_all filters, leave this blank.

ActionactionstringSelect a value from the drop down menu:forwardstorestop
Action Expressionaction_expressionstring

For the forward action, specify a destination email address or URL. For the store action, (optionally) specify a webhook URL to notify. For the stop action, leave this blank.

Halt on error?haltOnErrorboolean

Authentication

Mailgun uses API keys for authentication. When you connect your Mailgun account, Pipedream securely stores the keys so you can easily authenticate to Mailgun APIs in both code and no-code steps.

Get your API Key in the Control Panel, specifically in Settings > API Keys. More info in docs.

If your Mailgun account resides in the EU, choose the EU option in the Region field. Otherwise, choose the US (non-EU) region.

About Mailgun

Sending, receiving and tracking email effortlessly

More Ways to Use Mailgun

Triggers

New Bounce (Instant) from the Mailgun API

Emit new event when the email recipient could not be reached.

 
Try it
New Click (Instant) from the Mailgun API

Emit new event when the email recipient clicked on a link in the email. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. See more at the Mailgun User's Manual Tracking Messages section

 
Try it
New Complaint (Instant) from the Mailgun API

Emit new event when the email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.

 
Try it
New Delivery (Instant) from the Mailgun API

Emit new event when an email is sent and accepted by the recipient email server.

 
Try it
New Delivery Failure (Instant) from the Mailgun API

Emit new event when an email can't be delivered to the recipient email server.

 
Try it

Actions

Create Mailing List Member with the Mailgun API

Add to an existing mailing list. See the docs here

 
Try it
Delete Mailing List Member with the Mailgun API

Delete a mailing list member by address. See the docs here

 
Try it
Get Mailing List Member with the Mailgun API

Retrieve a mailing list member by address. See the docs here

 
Try it
Get Mailing List Members with the Mailgun API

List all mailing list members. See the docs here

 
Try it
List Domains with the Mailgun API

List domains in Mailgun. See the docs here

 
Try it