Create Post with Brilliant Directories API on New Cancelled Order (Instant) from Shopify Developer App API

Pipedream makes it easy to connect APIs for Brilliant Directories, Shopify Developer App and 2,000+ other apps remarkably fast.

Trigger workflow on

New Cancelled Order (Instant) from the Shopify Developer App API

Next, do this

Create Post with the Brilliant Directories API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Cancelled Order (Instant) trigger
1. Connect your Shopify Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create Post action
1. Connect your Brilliant Directories account
2. Configure User ID
3. Configure Data ID
4. Configure Data Type
5. Configure Post Title
6. Optional- Configure Post Content
7. Optional- Configure Post Category
8. Optional- Configure Post Type
9. Optional- Configure Post Tags
10. Optional- Configure Post Status
11. Optional- Configure Post Start Date
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 Cancelled Order (Instant) on Shopify Developer App

Description:Emit new event each time a new order is cancelled.

Version:0.0.2

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Developer App 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 common from "../common/webhook.mjs";
import constants from "../common/constants.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${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 Developer App	`app`	`app`	This component uses the Shopify Developer App 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
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook

Trigger Authentication#

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

Find your Shop ID

Get your Access Token

Next, 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 Developer App#

Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.

Action#

Create Post on Brilliant Directories

Description:Creates a single or group post. [See the documentation](https://support.brilliantdirectories.com/support/solutions/articles/12000093239-member-posts-api-create-update-delete-and-get-member-posts)

Version:0.0.1

Key:brilliant_directories-create-post

View on GitHub

Brilliant Directories Overview#

The Brilliant Directories API lets you tap into the functionality of your directory software, enabling you to automate tasks, manage listings, users, and more. With Pipedream, you can build serverless workflows integrating the Brilliant Directories API to streamline operations, sync data across platforms, and react to events in real-time.

Action Code#

import qs from "qs";
import app from "../../brilliant_directories.app.mjs";

export default {
  key: "brilliant_directories-create-post",
  name: "Create Post",
  description: "Creates a single or group post. [See the documentation](https://support.brilliantdirectories.com/support/solutions/articles/12000093239-member-posts-api-create-update-delete-and-get-member-posts)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    userId: {
      propDefinition: [
        app,
        "userId",
      ],
    },
    dataId: {
      propDefinition: [
        app,
        "dataId",
      ],
    },
    dataType: {
      propDefinition: [
        app,
        "dataType",
      ],
    },
    postTitle: {
      propDefinition: [
        app,
        "postTitle",
      ],
    },
    postContent: {
      propDefinition: [
        app,
        "postContent",
      ],
      optional: true,
    },
    postCategory: {
      propDefinition: [
        app,
        "postCategory",
      ],
      optional: true,
    },
    postType: {
      propDefinition: [
        app,
        "postType",
      ],
      optional: true,
    },
    postTags: {
      propDefinition: [
        app,
        "postTags",
      ],
      optional: true,
    },
    postStatus: {
      propDefinition: [
        app,
        "postStatus",
      ],
      optional: true,
    },
    postStartDate: {
      propDefinition: [
        app,
        "postStartDate",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.createPost({
      data: qs.stringify({
        user_id: this.userId,
        data_id: this.dataId,
        data_type: this.dataType,
        post_title: this.postTitle,
        post_content: this.postContent,
        post_category: this.postCategory,
        post_type: this.postType,
        post_tags: this.postTags && this.postTags.toString(),
        post_status: +this.postStatus,
        post_start_date: this.postStartDate,
      }),
    });

    $.export("$summary", `Successfully created post with ID: ${response.message?.post_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
Brilliant Directories	`app`	`app`	This component uses the Brilliant Directories app.
User ID	`userId`	`integer`	The unique identifier for a user.
Data ID	`dataId`	`integer`	The data id for the post.
Data Type	`dataType`	`integer`	The data type for the post.
Post Title	`postTitle`	`string`	The title of the post.
Post Content	`postContent`	`string`	The content of the post.
Post Category	`postCategory`	`string`	The category of the post.
Post Type	`postType`	`string`	The type of the post.
Post Tags	`postTags`	`string[]`	A list of tags to the post.
Post Status	`postStatus`	`boolean`	The status of the post.
Post Start Date	`postStartDate`	`string`	The start date of the post. Format yyyymmddhhmmss

Action Authentication#

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

About Brilliant Directories#

Brilliant Directories is software to manage business directories & membership websites.

More Ways to Connect Brilliant Directories + Shopify Developer App#

Other Popular Integrations#

Create User with Brilliant Directories API on New Article from Shopify Developer App API

Shopify Developer App + Brilliant Directories