Create Issue Comment with GitHub API on New Email Opened from Postmark API

Pipedream makes it easy to connect APIs for GitHub, Postmark and 1,600+ other apps remarkably fast.

Trigger workflow on

New Email Opened from the Postmark API

Next, do this

Create Issue Comment with the GitHub API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Email Opened trigger
1. Connect your Postmark account
2. Configure Track opens by default
3. Configure Track first open only
Configure the Create Issue Comment action
1. Connect your GitHub account
2. Select a Repository
3. Select a Issue Number
4. Configure Body
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 Email Opened on Postmark

Description:Emit new event when an email is opened by a recipient [(See docs here)](https://postmarkapp.com/developer/webhooks/open-tracking-webhook)

Version:0.0.1

Key:postmark-new-email-opened

View on GitHub

Postmark Overview#

What Is the Postmark API?

The Postmark API enables developers to easily integrate programmatic emailing into their applications. With the API, developers can create, send, and track transactional emails that are designed to enhance user experience and user engagement. The API also provides developers with access to powerful analytics and insights, such as open/click rates, spam complaints, bounces, and unsubscribes.

What Can You Build With the Postmark API?

The Postmark API allows developers to easily incorporate automated email notifications into their applications. Some examples of what you can build using the API are:

Welcome emails
Password reset emails
Email verification reminders
Event notification emails
Automated transactional emails
Billing and invoicing emails
Receipt emails
Email newsletters
Auto-responders and more!

Trigger Code#

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

export default {
  ...common,
  key: "postmark-new-email-opened",
  name: "New Email Opened",
  description:
    "Emit new event when an email is opened by a recipient [(See docs here)](https://postmarkapp.com/developer/webhooks/open-tracking-webhook)",
  version: "0.0.1",
  type: "source",
  props: {
    ...common.props,
    trackOpensByDefault: {
      type: "boolean",
      label: "Track opens by default",
      description: `If enabled, all emails being sent through this server will have open tracking enabled by default. Otherwise, only emails that have open tracking explicitly set will trigger this event when opened.
        \\
        **Note:** only emails with \`HTML Body\` will have open tracking enabled.
        `,
    },
    postFirstOpenOnly: {
      type: "boolean",
      label: "Track first open only",
      description: `If enabled, an event will only be emitted the first time the recipient opens the email.
        \\
        Otherwise, the event will be emitted every time an open occurs.`,
    },
  },
  methods: {
    ...common.methods,
    getWebhookProps() {
      return {
        PostFirstOpenOnly: this.postFirstOpenOnly,
        TrackOpens: this.trackOpensByDefault,
      };
    },
    getWebhookType() {
      return "OpenHookUrl";
    },
  },
};

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
Postmark	`postmark`	`app`	This component uses the Postmark app.
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.
Track opens by default	`trackOpensByDefault`	`boolean`	If enabled, all emails being sent through this server will have open tracking enabled by default. Otherwise, only emails that have open tracking explicitly set will trigger this event when opened. Note: only emails with `HTML Body` will have open tracking enabled.
Track first open only	`postFirstOpenOnly`	`boolean`	If enabled, an event will only be emitted the first time the recipient opens the email. Otherwise, the event will be emitted every time an open occurs.

Trigger Authentication#

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

About Postmark#

Application Email Service with Exceptional Delivery

Action#

Create Issue Comment on GitHub

Description:Create a new comment in a issue. [See docs here](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)

Version:0.0.13

Key:github-create-issue-comment

View on GitHub

Action Code#

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

export default {
  key: "github-create-issue-comment",
  name: "Create Issue Comment",
  description: "Create a new comment in a issue. [See docs here](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)",
  version: "0.0.13",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
    },
    issueNumber: {
      label: "Issue Number",
      description: "The number that identifies the issue.",
      type: "integer",
      propDefinition: [
        github,
        "issueNumber",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
    body: {
      label: "Body",
      description: "The contents of the comment",
      type: "string",
    },
  },
  async run({ $ }) {
    const response = await this.github.createIssueComment({
      repoFullname: this.repoFullname,
      issueNumber: this.issueNumber,
      data: {
        body: this.body,
      },
    });

    $.export("$summary", "Successfully commented in the issue.");

    return response;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
Issue Number	`issueNumber`	`integer`	Select a value from the drop down menu.
Body	`body`	`string`	The contents of the comment

Action 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_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

Create Issue Comment with GitHub API on New Email Opened from Postmark API

Pipedream makes it easy to connect APIs for GitHub, Postmark and 1,600+ other apps remarkably fast.

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

Developers ♥ Pipedream

What Can You Build With the Postmark API?

1-12of1,600+apps by most popular

1
-
12
of
1,600+
apps by most popular