← Netlify + Mailgun integrations

Mailgun Suppress Email with Mailgun APIon New Deploy Failure (Instant) from Netlify API

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

Trigger workflow on
New Deploy Failure (Instant) from the Netlify API
Next, do this
Mailgun Suppress Email with the Mailgun API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New Deploy Failure (Instant) trigger
    1. Connect your Netlify account
    2. Select a Site ID
  3. Configure the Mailgun Suppress Email action
    1. Connect your Mailgun account
    2. Select a Domain Name
    3. Configure Email Address
    4. Select a category
    5. Optional- Configure Bounce Error Code
    6. Optional- Configure Bounce Error Message
    7. Optional- Configure Tag to unsubscribe from
    8. Configure Halt on error?
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emits an event when a new deployment fails
Version:0.0.1
Key:netlify-new-deploy-failure

Trigger Code

const common = require("../../common");

module.exports = {
  ...common,
  key: "netlify-new-deploy-failure",
  name: "New Deploy Failure (Instant)",
  description: "Emits an event when a new deployment fails",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getHookEvent() {
      return "deploy_failed";
    },
    getMetaSummary(data) {
      const { commit_ref } = data;
      return `Deploy failed for commit ${commit_ref}`;
    },
  },
};

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.
LabelPropTypeDescription
NetlifynetlifyappThis component uses the Netlify app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
N/Ahttp$.interface.httpThis 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.
Site IDsiteIdstringSelect a value from the drop down menu.

Trigger Authentication

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

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

About Netlify

All-in-one platform for automating modern web projects

Action

Description:Add email to the Mailgun suppression list.
Version:0.0.1
Key:mailgun-suppress-email

Action Code

const mailgun = require("../../mailgun.app.js");

module.exports = {
  key: "mailgun-suppress-email",
  name: "Mailgun Suppress Email",
  description: "Add email to the Mailgun suppression list.",
  version: "0.0.1",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    email: {
      propDefinition: [
        mailgun,
        "email",
      ],
    },
    category: {
      type: "string",
      options: [
        "bounces",
        "unsubscribes",
        "complaints",
      ],
    },
    bounceErrorCode: {
      type: "string",
      label: "Bounce Error Code",
      default: "550",
      optional: true,
    },
    bounceErrorMessage: {
      type: "string",
      label: "Bounce Error Message",
      optional: true,
    },
    unsubscribeFrom: {
      type: "string",
      label: "Tag to unsubscribe from",
      description: "Use * to unsubscribe an address from all domain’s correspondence",
      default: "*",
      optional: true,
    },
    haltOnError: {
      propDefinition: [
        mailgun,
        "haltOnError",
      ],
    },
  },
  async run () {
    try {
      const suppression = {
        address: this.email,
      };

      switch (this.category) {
      case "bounces":
        suppression.code = this.bounceErrorCode;
        suppression.error = this.bounceErrorMessage;
        break;

      case "unsubscribes":
        suppression.tag = this.unsubscribeFrom;
        break;
      }

      return await this.mailgun.suppress(this.domain, this.category, suppression);
    } catch (err) {
      if (this.haltOnError) {
        throw err;
      }
      if (err.response) {
        return err.response.data;
      }
      return err;
    }
  },
};

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.

LabelPropTypeDescription
MailgunmailgunappThis component uses the Mailgun app.
Domain NamedomainstringSelect a value from the drop down menu.
Email Addressemailstring
categorycategorystringSelect a value from the drop down menu:bouncesunsubscribescomplaints
Bounce Error CodebounceErrorCodestring
Bounce Error MessagebounceErrorMessagestring
Tag to unsubscribe fromunsubscribeFromstring

Use * to unsubscribe an address from all domain’s correspondence

Halt on error?haltOnErrorboolean

Action 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

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.