← GitHub + Mailgun integrations

Send Email with Mailgun API on Custom Webhook Events from GitHub API

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

Trigger workflow on
Custom Webhook Events from the GitHub API
Next, do this
Send 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 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a GitHub 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 Custom Webhook Events trigger
    1. Connect your GitHub account
    2. Select a Repo
    3. Select one or more Events
  3. Configure the Send Email action
    1. Connect your Mailgun account
    2. Select a Domain Name
    3. Configure From Name
    4. Configure From Email
    5. Optional- Configure Reply-To
    6. Configure To
    7. Configure Subject
    8. Optional- Configure Message Body (text)
    9. Optional- Configure Message Body (HTML)
    10. Configure Send in test mode?
    11. Optional- Configure Use DKIM?
    12. Optional- Configure Use Tracking?
    13. 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:Emit new events of selected types
Version:0.0.7
Key:github-custom-events

Trigger Code

const github = require("../../github.app.js");
const common = require("../common-webhook.js");

module.exports = {
  ...common,
  key: "github-custom-events",
  name: "Custom Webhook Events",
  description:
    "Emit new events of selected types",
  type: "source",
  version: "0.0.7",
  props: {
    ...common.props,
    events: {
      propDefinition: [
        github,
        "events",
      ],
    },
  },
  dedupe: "unique",
  methods: {
    getEventNames() {
      return this.events;
    },
    generateMeta(data, id) {
      const ts = Date.now();
      return {
        id,
        summary: `${data.action} event by ${data.sender.login}`,
        ts,
      };
    },
    emitEvent(body, id) {
      const meta = this.generateMeta(body, id);
      this.$emit(body, meta);
    },
  },
};

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
GitHubgithubappThis component uses the GitHub app.
ReporepoFullNamestringSelect a value from the drop down menu.
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.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Eventseventsstring[]Select a value from the drop down menu:check_runcheck_suitecode_scanning_alertcommit_commentcontent_referencecreatedeletedeploy_keydeploymentdeployment_statusdiscussiondiscussion_commentforkgithub_app_authorizationgolluminstallationinstallation_repositoriesissue_commentissueslabelmarketplace_purchasemembermembershipmetamilestoneorganizationorg_blockpackagepage_buildpingproject_cardproject_columnprojectpublicpull_requestpull_request_reviewpull_request_review_commentpushreleaserepository_dispatchrepositoryrepository_importrepository_vulnerability_alertsecret_scanning_alertsecurity_advisorysponsorshipstarstatusteamteam_addwatchworkflow_dispatchworkflow_run

Trigger Authentication

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action

Description:Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)
Version:0.0.29
Key:mailgun-send-email

Action Code

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

export default {
  ...common,
  key: "mailgun-send-email",
  name: "Send Email",
  description: "Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
  version: "0.0.29",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    fromName: {
      propDefinition: [
        mailgun,
        "name",
      ],
      label: "From Name",
      description: "Sender name",
    },
    from: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "From Email",
      description: "Sender email address",
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    replyTo: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "Reply-To",
      description: "Sender reply email address",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    to: {
      propDefinition: [
        mailgun,
        "emails",
      ],
      label: "To",
      description: "Recipient email address(es)",
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    subject: {
      propDefinition: [
        mailgun,
        "subject",
      ],
      description: "Message subject",
    },
    text: {
      propDefinition: [
        mailgun,
        "bodyText",
      ],
      optional: true,
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    html: {
      propDefinition: [
        mailgun,
        "bodyHtml",
      ],
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    testMode: {
      type: "boolean",
      label: "Send in test mode?",
      default: true,
      description: "Enables sending in test mode. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
    },
    dkim: {
      type: "boolean",
      label: "Use DKIM?",
      default: true,
      description: "Enables or disables DKIM signatures. For more information, see the [Mailgun " +
        "API documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    tracking: {
      type: "boolean",
      label: "Use Tracking?",
      default: true,
      description: "Enables or disables tracking. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    const msg = {
      "from": `${this.fromName} <${this.from}>`,
      "to": this.to,
      "subject": this.subject,
      "text": this.text,
      "html": this.html,
    };
    if (this.testMode) {
      msg["o:testmode"] = "yes";
    }
    if (this.replyTo) {
      msg["h:Reply-To"] = this.replyTo;
    }
    if (this.dkim !== null) {
      msg["o:dkim"] = this.dkim
        ? "yes"
        : "no";
    }
    if (this.tracking) {
      msg["o:tracking"] = "yes";
    }
    const resp = await this.withErrorHandler(this.mailgun.sendMail, {
      domain: this.domain,
      msg,
    });
    $.export("$summary", "Successfully sent 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.
From NamefromNamestring

Sender name

From Emailfromstring

Sender email address

Reply-ToreplyTostring

Sender reply email address

Totostring[]

Recipient email address(es)

Subjectsubjectstring

Message subject

Message Body (text)textstring
Message Body (HTML)htmlstring
Send in test mode?testModeboolean

Enables sending in test mode. For more information, see the Mailgun API documentation

Use DKIM?dkimboolean

Enables or disables DKIM signatures. For more information, see the Mailgun API documentation

Use Tracking?trackingboolean

Enables or disables tracking. For more information, see the Mailgun API documentation

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 + GitHub