Send Single Email with Postmark API on New App Installs from Shopify Partner API

Pipedream makes it easy to connect APIs for Postmark, Shopify Partner and 2,400+ other apps remarkably fast.

Trigger workflow on

New App Installs from the Shopify Partner API

Next, do this

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

Select this integration
Configure the New App Installs trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Configure Shopify App ID
4. Optional- Configure occurredAtMin
5. Optional- Configure occurredAtMax
Configure the Send Single Email action
1. Connect your Postmark account
2. Configure Subject
3. Optional- Configure HTML Body
4. Optional- Configure Text Body
5. Configure "From" email address
6. Configure Recipient email address(es)
7. Optional- Configure CC email address(es)
8. Optional- Configure BCC email address(es)
9. Optional- Configure Tag
10. Optional- Configure "Reply To" email address
11. Optional- Configure Custom Headers
12. Optional- Configure Track Opens
13. Optional- Select a Track Links
14. Optional- Configure Attachments
15. Optional- Configure Metadata
16. Optional- Configure Message stream
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 App Installs on Shopify Partner

Description:Emit new events when new shops install your app.

Version:0.1.3

Key:shopify_partner-new-app-installs

View on GitHub

Shopify Partner Overview#

The Shopify Partner API lets you tap into a comprehensive suite of features to manage and analyze multiple Shopify stores. You can automate tasks like creating development stores, adding collaborators, tracking payouts, and more. This API serves as a powerful tool for developers, agencies, and freelancers who manage multiple Shopify shops for their clients. Through Pipedream, you can effortlessly integrate Shopify Partner API with other services to create tailored, efficient workflows that save time and enhance productivity.

Trigger Code#

import common from "../../common/common.mjs";
import shopify from "../../shopify_partner.app.mjs";
import getAppInstalls from "../../common/queries/getAppInstalls.mjs";

export default {
  key: "shopify_partner-new-app-installs",
  name: "New App Installs",
  type: "source",
  version: "0.1.3",
  description: "Emit new events when new shops install your app.",
  ...common,
  props: {
    ...common.props,
    db: "$.service.db",
    appId: {
      propDefinition: [
        shopify,
        "appId",
      ],
    },
    occurredAtMin: {
      propDefinition: [
        shopify,
        "occurredAtMin",
      ],
    },
    occurredAtMax: {
      propDefinition: [
        shopify,
        "occurredAtMax",
      ],
    },
  },
  async run() {
    const {
      appId, occurredAtMin, occurredAtMax, db,
    } = this;

    const variables = {
      appId: `gid://partners/App/${appId}`,
    };
    if (occurredAtMin) {
      variables.occurredAtMin = occurredAtMin.trim();
    }
    if (occurredAtMax) {
      variables.occurredAtMax = occurredAtMax.trim();
    }

    await this.shopify.query({
      db,
      key: "shopify_partner-installs",
      query: getAppInstalls,
      variables,
      handleEmit: (data) => {
        if (data?.app?.events) {
          data.app.events.edges.map(({ node: { ...event } }) => {
            this.$emit(event, {
              id: event.occurredAt,
              summary: `${event.shop.name} (${event.shop.myshopifyDomain}) installed ${event.app.name}`,
            });
          });
        }
      },
      getCursor: (data) => {
        const edges = data?.transactions?.edges || [];
        const [
          last,
        ] = edges.reverse();
        return last?.cursor;
      },
      hasNextPagePath: "app.events.pageInfo.hasNextPage",
    });
  },
};

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
Shopify Partner	`shopify`	`app`	This component uses the Shopify Partner app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
timer	`timer`	`$.interface.timer`	API Polling Frequency
Shopify App ID	`appId`	`string`	Open your app in the partner portal, and look at the URL to find its ID. If your URL is https://partners.shopify.com/3027494/apps/51358007297/overview, enter `51358007297` here.
occurredAtMin	`occurredAtMin`	`string`	Only include events after this specific time (ISO timestamp)
occurredAtMax	`occurredAtMax`	`string`	Only include events up to this specific time (ISO timestamp)

Trigger Authentication#

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

Create an API Key

In order to authorize Pipedream to access your Shopify Partner Account, you will need to generate a new API key for Pipedream to use on your behalf.

First, create an API client in your Shopify Partner account.

Make sure to include these scopes:

View financials
Manage apps

You will use this API key to authenticate your Pipedream workflows with Shopify Partners.

Open API key management in the Shopify Partner Portal

Create a new API key

Create API key

Enter in "Pipedream" as the name and select the appropriate scopes, then click "Save" to finish

Enter in Pipedream API key options

Find your Organization ID

After you log into the Shopify Partner portal, look at the URL for your organization ID

Find your Shopify Partner Organization ID

Find your App ID

After opening your app in the partner portal, look in the URL to find it's ID:

Find your Shopify App ID

About Shopify Partner#

Shopify Partner API connection. Listen to events like installs, uninstalls, charges & transactions.

Action#

Send Single Email on Postmark

Description:Send a single email with Postmark [See the documentation](https://postmarkapp.com/developer/api/email-api#send-a-single-email)

Version:0.2.3

Key:postmark-send-single-email

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.

Action Code#

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

const {
  postmark, ...props
} = common.props;

export default {
  ...common,
  key: "postmark-send-single-email",
  name: "Send Single Email",
  description: "Send a single email with Postmark [See the documentation](https://postmarkapp.com/developer/api/email-api#send-a-single-email)",
  version: "0.2.3",
  type: "action",
  props: {
    postmark,
    subject: {
      type: "string",
      label: "Subject",
      description: "Email subject.",
    },
    htmlBody: {
      type: "string",
      label: "HTML Body",
      description:
        `HTML email message.
        \\
        **Required** if no \`Text Body\` is specified.
        \\
        **Required** to enable \`Open Tracking\`.`,
      optional: true,
    },
    textBody: {
      type: "string",
      label: "Text Body",
      description:
        `Plain text email message.
        \\
        **Required** if no \`HTML Body\` is specified.`,
      optional: true,
    },
    // The above props are intentionally placed first
    ...props,
  },
  async run({ $ }) {
    const response = await this.postmark.sendSingleEmail({
      $,
      data: {
        ...this.getActionRequestCommonData(),
        Subject: this.subject,
        HtmlBody: this.htmlBody,
        TextBody: this.textBody,
      },
    });
    $.export("$summary", "Sent email successfully");
    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
Postmark	`postmark`	`app`	This component uses the Postmark app.
Subject	`subject`	`string`	Email subject.
HTML Body	`htmlBody`	`string`	HTML email message. Required if no `Text Body` is specified. Required to enable `Open Tracking`.
Text Body	`textBody`	`string`	Plain text email message. Required if no `HTML Body` is specified.
"From" email address	`fromEmail`	`string`	The sender email address. Must have a registered and confirmed Sender Signature. To include a name, use the format 'Full Name <sender@domain.com>' for the address.
Recipient email address(es)	`toEmail`	`string`	Recipient email address. Multiple addresses are comma separated. Max 50.
CC email address(es)	`ccEmail`	`string`	Cc recipient email address. Multiple addresses are comma separated. Max 50.
BCC email address(es)	`bccEmail`	`string`	Bcc recipient email address. Multiple addresses are comma separated. Max 50.
Tag	`tag`	`string`	Email tag that allows you to categorize outgoing emails and get detailed statistics.
"Reply To" email address	`replyTo`	`string`	Reply To override email address. Defaults to the Reply To set in the sender signature.
Custom Headers	`customHeaders`	`string[]`	List of custom headers to include.
Track Opens	`trackOpens`	`boolean`	Activate open tracking for this email. Note: the email must have `HTML Body` to enable open tracking.
Track Links	`trackLinks`	`string`	Select a value from the drop down menu:`NoneHtmlAndTextHtmlOnlyTextOnly`
Attachments	`attachments`	`string[]`	Each attachment should be a string with the parameters separated by a pipe character `\|`, in the format: `Name\|Content\|ContentType`. Alternatively, you can pass a string representing an object. All three parameters are required: `Name` - the filename with extension, i.e. `readme.txt` `Content` - the base64-encoded string with the binary data for the file, i.e. `dGVzdCBjb250ZW50` `ContentType` - the MIME content type, i.e. `text/plain` Example with pipe-separated parameters: `readme.txt\|dGVzdCBjb250ZW50\|text/plain` Example with JSON-stringified object: `{"Name":"readme.txt","Content":"dGVzdCBjb250ZW50","ContentType":"text/plain"}`
Metadata	`metadata`	`object`	Custom metadata key/value pairs.
Message stream	`messageStream`	`string`	Set message stream ID that's used for sending. If not provided, message will default to the outbound transactional stream.