Create Email Message with Selzy API on New Shipment (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Selzy, Shopify and 2,700+ other apps remarkably fast.

Trigger workflow on

New Shipment (Instant) from the Shopify API

Next, do this

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

Select this integration
Configure the New Shipment (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create Email Message action
1. Connect your Selzy account
2. Configure Sender's name
3. Configure Sender's email address
4. Configure Subject
5. Configure Body
6. Select a List ID
7. Optional- Configure Text Body
8. Configure Generate Text
9. Optional- Configure Raw Body
10. Optional- Select a Message Format
11. Optional- Configure Lang
12. Optional- Select a Template Id
13. Optional- Select a System Template Id
14. Optional- Select a Wrap Type
15. Optional- Configure Categories
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 Shipment (Instant) on Shopify

Description:Emit new event for each new fulfillment event for a store.

Version:0.0.4

Key:shopify_developer_app-new-shipment

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-shipment",
  name: "New Shipment (Instant)",
  type: "source",
  description: "Emit new event for each new fulfillment event for a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_FULFILLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `New Shipped Order ${resource.id}.`,
        ts,
      };
    },
  },
};

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	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Create Email Message on Selzy

Description:Adds a new email message. [See the documentation](https://selzy.com/en/support/category/api/messages/)

Version:0.0.1

Key:selzy-create-email-message

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  MESSAGE_FORMAT_OPTIONS, WRAP_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import selzy from "../../selzy.app.mjs";

export default {
  key: "selzy-create-email-message",
  name: "Create Email Message",
  description: "Adds a new email message. [See the documentation](https://selzy.com/en/support/category/api/messages/)",
  version: "0.0.1",
  type: "action",
  props: {
    selzy,
    senderName: {
      type: "string",
      label: "Sender's name",
      description: "It is a string that does not match the email address (the sender_email argument).",
    },
    senderEmail: {
      type: "string",
      label: "Sender's email address",
      description: "This email must be checked (to do this, you need to manually create at least one email with this return address via the web interface, then click on the \"send the confirmation request\" link and follow the link from the email).",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "String with the letter subject. It may include substitution fields. If you wish to use substitution fields, specify a string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"Welcome to Our Newsletter, \\{\\{Name\\}\\}!\" }}`. The parameter is optional if Template Id is indicated.",
    },
    body: {
      type: "string",
      label: "Body",
      description: "HTML body of the letter. It may include substitution fields. If you wish to use substitution fields, specify an HTML string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"<p>Hello \\{\\{Name\\}\\},</p><p>Here is your update.</p>\" }}`.",
    },
    listId: {
      propDefinition: [
        selzy,
        "listId",
      ],
    },
    textBody: {
      type: "string",
      label: "Text Body",
      description: "Text body of the letter. It may include substitution fields. If you wish to use substitution fields, specify a text string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"Hello \\{\\{Name\\}\\},\\nHere is your update.\" }}`.",
      optional: true,
    },
    generateText: {
      type: "boolean",
      label: "Generate Text",
      description: "`True` means that the text part of the letter will be generated automatically based on the HTML part. If you do not provide the text version along with the HTML version, you are recommended to set the **Generate Text** parameter to `true` for automatic generation of the text part of the letter. If the text variant of the letter is provided using the **Text Body** parameter, the **Generate Text** parameter is ignored. Thus, if the **Generate Text** value has been set to `true`, the server's response will contain a warning.",
    },
    rawBody: {
      type: "string",
      label: "Raw Body",
      description: "It is intended to save the json structure of the block editor data structure (if the value is **Message Format** = block) The parameter obtains only the JSON structure, otherwise it will not be transferred.",
      optional: true,
    },
    messageFormat: {
      type: "string",
      label: "Message Format",
      description: `It defines the manner of creating a letter.
        \n 1 - If you transfer the \`text\` value in this parameter and both the body and **Text Body** parameters are filled, the body parameter will be ignored, and the letter will be created from the data, transferred in the **Text Body** parameter.
        \n 2 - If you transfer the \`block\` value in this parameter but do not specify **Raw Body**, the letter will be saved as **Raw HTML**.
        \n 3 - If you transfer the \`block\` value in this parameter, the **body** and **Raw Body** parameters must be transferred so taht you can save the message in the block editor format.`,
      options: MESSAGE_FORMAT_OPTIONS,
      optional: true,
    },
    lang: {
      type: "string",
      label: "Lang",
      description: `Two-letter language code for the string with the unsubscribe link that is added to each letter automatically.
        If it is not specified, the language code from the API URL is used.
        In addition to the string with the unsubscribe link, this language also affects the interface of the unsubscribe page. Languages en, it, ua and ru are fully supported, and in case of some other languages (da, de, es, fr, nl, pl, pt, tr), the string with a link will be translated, and the control interface will be in English.`,
      optional: true,
    },
    templateId: {
      propDefinition: [
        selzy,
        "templateId",
      ],
      optional: true,
    },
    systemTemplateId: {
      propDefinition: [
        selzy,
        "systemTemplateId",
      ],
      optional: true,
    },
    wrapType: {
      type: "string",
      label: "Wrap Type",
      description: "Alignment of the message text on the specified side. If the argument is missing, the text will not be aligned.",
      options: WRAP_TYPE_OPTIONS,
      optional: true,
    },
    categories: {
      type: "string[]",
      label: "Categories",
      description: "A list of letter categories.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.templateId && this.systemTemplateId) {
      throw new ConfigurationError("You can only use one of the Template Id or System Template Id parameters.");
    }
    const response = await this.selzy.createEmailMessage({
      $,
      params: {
        sender_name: this.senderName,
        sender_email: this.senderEmail,
        subject: this.subject,
        body: this.body,
        list_id: this.listId,

        text_body: this.textBody,
        generate_text: +this.generateText,
        raw_body: this.rawBody,
        message_format: this.messageFormat,
        lang: this.lang,
        template_id: this.templateId,
        system_template_id: this.systemTemplateId,
        wrap_type: this.wrapType,
        categories: parseObject(this.categories)?.join(","),
      },
    });

    if (response.error) throw new ConfigurationError(response.error);

    $.export("$summary", `Email message created successfully with ID ${response.result.message_id}.`);
    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
Selzy	`selzy`	`app`	This component uses the Selzy app.
Sender's name	`senderName`	`string`	It is a string that does not match the email address (the sender_email argument).
Sender's email address	`senderEmail`	`string`	This email must be checked (to do this, you need to manually create at least one email with this return address via the web interface, then click on the "send the confirmation request" link and follow the link from the email).
Subject	`subject`	`string`	String with the letter subject. It may include substitution fields. If you wish to use substitution fields, specify a string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "Welcome to Our Newsletter, \{\{Name\}\}!" }}`. The parameter is optional if Template Id is indicated.
Body	`body`	`string`	HTML body of the letter. It may include substitution fields. If you wish to use substitution fields, specify an HTML string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "<p>Hello \{\{Name\}\},</p><p>Here is your update.</p>" }}`.
List ID	`listId`	`string`	Select a value from the drop down menu.
Text Body	`textBody`	`string`	Text body of the letter. It may include substitution fields. If you wish to use substitution fields, specify a text string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "Hello \{\{Name\}\},\nHere is your update." }}`.
Generate Text	`generateText`	`boolean`	`True` means that the text part of the letter will be generated automatically based on the HTML part. If you do not provide the text version along with the HTML version, you are recommended to set the Generate Text parameter to `true` for automatic generation of the text part of the letter. If the text variant of the letter is provided using the Text Body parameter, the Generate Text parameter is ignored. Thus, if the Generate Text value has been set to `true`, the server's response will contain a warning.
Raw Body	`rawBody`	`string`	It is intended to save the json structure of the block editor data structure (if the value is Message Format = block) The parameter obtains only the JSON structure, otherwise it will not be transferred.
Message Format	`messageFormat`	`string`	Select a value from the drop down menu:`{ "label": "Raw HTML", "value": "raw_html" }{ "label": "Block", "value": "block" }{ "label": "Text", "value": "text" }`
Lang	`lang`	`string`	Two-letter language code for the string with the unsubscribe link that is added to each letter automatically. If it is not specified, the language code from the API URL is used. In addition to the string with the unsubscribe link, this language also affects the interface of the unsubscribe page. Languages en, it, ua and ru are fully supported, and in case of some other languages (da, de, es, fr, nl, pl, pt, tr), the string with a link will be translated, and the control interface will be in English.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
System Template Id	`systemTemplateId`	`string`	Select a value from the drop down menu.
Wrap Type	`wrapType`	`string`	Select a value from the drop down menu:`{ "label": "Skip (Do not apply)", "value": "skip" }{ "label": "Right (Right alignment)", "value": "right" }{ "label": "Left (Left alignment)", "value": "left" }{ "label": "Center (Center alignment)", "value": "center" }`
Categories	`categories`	`string[]`	A list of letter categories.

Create Email Message with Selzy API on New Shipment (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Selzy, Shopify and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,700+apps by most popular

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