Suppress Email with Mailgun API on New Form Submission (Instant) from Netlify API

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

Trigger workflow on

New Form Submission (Instant) from the Netlify API

Next, do this

Suppress Email with the Mailgun 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 Netlify trigger and Mailgun action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Form Submission (Instant) trigger
1. Connect your Netlify account
2. Select a Site ID
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?
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 Form Submission (Instant) on Netlify

Description:Emit new event when a user submits a form

Version:0.1.1

Key:netlify-new-form-submission

View on GitHub

Netlify Overview#

Harness the power of the Netlify API on Pipedream to automate your web development workflows, streamline site deployments, manage DNS settings, and more. With Pipedream's serverless platform, you can orchestrate Netlify's capabilities in concert with numerous other services to enhance productivity, monitor your deployments, and react to events in real-time. Create custom CI/CD pipelines, synchronize your site's content with third-party systems, or automate responses to form submissions, all with the seamless integration of the Netlify API within Pipedream workflows.

Trigger Code#

import webhook from "../common/webhook.mjs";
import { deployHooks } from "../common/constants.mjs";

export default {
  ...webhook,
  key: "netlify-new-form-submission",
  name: "New Form Submission (Instant)",
  description: "Emit new event when a user submits a form",
  type: "source",
  version: "0.1.1",
  dedupe: "unique",
  methods: {
    ...webhook.methods,
    getHookEvent() {
      return deployHooks.SUBMISSION_CREATED;
    },
    getMetaSummary(data) {
      const { form_name: formName } = data;
      return `New form submission for ${formName}`;
    },
  },
};

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
Netlify	`netlify`	`app`	This component uses the Netlify 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.
Site ID	`siteId`	`string`	Select 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#

Suppress Email on Mailgun

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.4

Key:mailgun-suppress-email

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

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.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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.

Label	Prop	Type	Description
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Email Address	`email`	`string`
Category	`category`	`string`	Select a value from the drop down menu:`bouncesunsubscribescomplaints`
Bounce Error Code	`bounceErrorCode`	`string`	Email bounce error code
Bounce Error Message	`bounceErrorMessage`	`string`	Email bounce error message
Tag to unsubscribe from	`unsubscribeFrom`	`string`	Use * to unsubscribe an address from all domain’s correspondence
Halt on error?	`haltOnError`	`boolean`

Suppress Email with Mailgun API on New Form Submission (Instant) from Netlify API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular