← HTTP / Webhook + Mailgun integrations

Suppress Email with Mailgun API on New Requests (Payload Only) from HTTP / Webhook API

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

Trigger workflow on
New Requests (Payload Only) from the HTTP / Webhook API
Next, do this
Suppress Email 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 500,000+ developers from startups to Fortune 500 companies

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

This integration creates a workflow with a HTTP / Webhook 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 Requests (Payload Only) trigger
    1. Connect your HTTP / Webhook account
  3. Configure the 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, 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

Description:Get a URL and emit the HTTP body as an event on every request
Version:0.1.1
Key:http-new-requests-payload-only

Trigger Code

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/AhttpInterface$.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.
HTTP / WebhookhttpappThis component uses the HTTP / Webhook app.

Trigger Authentication

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook

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

Action

Description:Add email to the Mailgun suppression list. [See the docs here](https://documentation.mailgun.com/en/latest/api-suppressions.html#suppressions)
Version:0.0.3
Key:mailgun-suppress-email

Mailgun Overview

Mailgun allows you to send and receive emails using their API. With Mailgun,
you can build a variety of applications and services that can send or receive
emails. Here are a few examples of what you can build with Mailgun:

  • A simple email service that can send or receive emails
  • An email marketing service that can send mass emails
  • A notification service that can send emails when certain events occur
  • A task management service that can send emails when tasks are due
  • A customer support service that can send or receive emails from customers

Action Code

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

export default {
  ...common,
  key: "mailgun-suppress-email",
  name: "Suppress Email",
  description: "Add email to the Mailgun suppression list. [See the docs here](https://documentation.mailgun.com/en/latest/api-suppressions.html#suppressions)",
  version: "0.0.3",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    email: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
    },
    category: {
      type: "string",
      label: "Category",
      description: "Which suppression list to add the email to",
      options: [
        "bounces",
        "unsubscribes",
        "complaints",
      ],
    },
    bounceErrorCode: {
      type: "string",
      label: "Bounce Error Code",
      description: "Email bounce error code",
      default: "550",
      optional: true,
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    bounceErrorMessage: {
      type: "string",
      label: "Bounce Error Message",
      description: "Email bounce error message",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    unsubscribeFrom: {
      type: "string",
      label: "Tag to unsubscribe from",
      description: "Use * to unsubscribe an address from all domain’s correspondence",
      default: "*",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    const urlSearchParams = new URLSearchParams();
    urlSearchParams.append("address", this.email);
    switch (this.category) {
    case "bounces":
      urlSearchParams.append("code", this.bounceErrorCode);
      urlSearchParams.append("error", this.bounceErrorMessage);
      break;
    case "unsubscribes":
      urlSearchParams.append("tag", this.unsubscribeFrom);
      break;
    }
    const params = urlSearchParams.toString();
    const url = `v3/${this.domain}/${this.category}?${params}`;
    const resp = await this.withErrorHandler(this.mailgun.mailgunPostRequest, url);
    $.export("$summary", "Successfully suppressed email");
    return resp;
  },
};

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

Email bounce error code

Bounce Error MessagebounceErrorMessagestring

Email bounce error message

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

More Ways to Connect Mailgun + HTTP / Webhook

Mailgun Send Email with Mailgun API on New Requests from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Mailgun Suppress Email with Mailgun API on New Requests from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Mailgun Verify Email with Mailgun API on New Requests from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Mailgun Send Email with Mailgun API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
Try it
Mailgun Verify Email with Mailgun API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Mailgun
 
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
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
Send any HTTP Request with the HTTP / Webhook API

Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.

 
Try it
Send GET Request with the HTTP / Webhook API

Send an HTTP GET request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Send POST Request with the HTTP / Webhook API

Send an HTTP POST request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Send PUT Request with the HTTP / Webhook API

Send an HTTP PUT request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Return HTTP Response with the HTTP / Webhook API

Use with an HTTP Source that uses Return a custom response from your workflow as its HTTP Response

 
Try it