Publish Push Notification with Ably API on New Page from Shopify API

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

Trigger workflow on

New Page from the Shopify API

Next, do this

Publish Push Notification with the Ably 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 Ably action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Page trigger
1. Connect your Shopify account
2. Configure timer
Configure the Publish Push Notification action
1. Connect your Ably account
2. Configure Channel Name
3. Configure Notification Title
4. Configure Notification Body
5. Configure Notification Data
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 Page on Shopify

Description:Emit new event for each new page published.

Version:0.0.3

Key:shopify_developer_app-new-page

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 shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/sources/new-page/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-page",
  name: "New Page",
  type: "source",
  description: "Emit new event for each new page published.",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    shopify,
    ...common.props,
  },
};

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	`shopify`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

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#

Publish Push Notification on Ably

Description:Publish a push notification for a channel. [See docs here](https://ably.com/docs/general/push/publish#channel-broadcast-example)

Version:0.0.1

Key:ably-publish-push-notification

View on GitHub

Ably Overview#

Ably API provides a platform for adding real-time messaging, streaming, and presence capabilities to your apps. With Pipedream, you can harness this power to create dynamic, event-driven workflows. Automate notifications, synchronize data across systems in real time, or react to Ably events to trigger actions in other services, like sending emails, updating databases, or calling external APIs.

Action Code#

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

export default {
  name: "Publish Push Notification",
  version: "0.0.1",
  key: "ably-publish-push-notification",
  description: "Publish a push notification for a channel. [See docs here](https://ably.com/docs/general/push/publish#channel-broadcast-example)",
  type: "action",
  props: {
    ably,
    channelName: {
      propDefinition: [
        ably,
        "channelName",
      ],
      description: "The name of channel that will be published",
    },
    notificationTitle: {
      label: "Notification Title",
      description: "The title of push notification",
      type: "string",
    },
    notificationBody: {
      label: "Notification Body",
      description: "The body of push notification",
      type: "string",
    },
    notificationData: {
      label: "Notification Data",
      description: "The data of push notification",
      type: "object",
    },
  },
  async run({ $ }) {
    const response = await this.ably.publishMessage({
      $,
      channelName: this.channelName,
      data: {
        name: this.eventName,
        data: this.notificationData,
        extras: {
          push: {
            data: this.notificationData,
            notification: {
              title: this.notificationTitle,
              body: this.notificationBody,
            },
          },
        },
      },
    });

    if (response.messageId) {
      $.export("$summary", `Successfully pushed notification with ID ${response.messageId}`);
    }

    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
Ably	`ably`	`app`	This component uses the Ably app.
Channel Name	`channelName`	`string`	The name of channel that will be published
Notification Title	`notificationTitle`	`string`	The title of push notification
Notification Body	`notificationBody`	`string`	The body of push notification
Notification Data	`notificationData`	`object`	The data of push notification

Action Authentication#

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

The full application key string can obtained through the dashboard and split at the colon.
api_key_initial is the initial segment of the api key before the colon used as the user name
api_key_remaining is the remaining string (without the leading colon) used as the password.

Publish Push Notification with Ably API on New Page from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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