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

Pipedream makes it easy to connect APIs for GitHub, Postmark and 2,500+ 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

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

Key:postmark-new-email-opened

View on GitHub

Postmark Overview#

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.

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.4",
  type: "source",
  props: {
    ...common.props,
    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 {
        Triggers: {
          "Open": {
            "Enabled": true,
            "PostFirstOpenOnly": false,
          },
        },
      };
    },
    getSummary(body) {
      return `New email opened! MessageID - ${body.MessageID}`;
    },
  },
};

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	`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.
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#

Postmark is a fast and reliable email delivery service that enables you to send transactional and marketing emails and get them to the inbox on time, every time.

Action#

Create Issue Comment on GitHub

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

Version:0.0.21

Key:github-create-issue-comment

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

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 the documentation](https://docs.github.com/en/rest/issues/comments#create-an-issue-comment)",
  version: "0.0.21",
  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:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin: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.

More Ways to Connect GitHub + Postmark#

Other Popular Integrations#

Send an Email with Postmark to a Single Recipient with Postmark API on New Commit from GitHub API

GitHub + Postmark

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

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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