Trigger a Pipeline with CircleCI API on New Article from Shopify API

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

Trigger workflow on

New Article from the Shopify API

Next, do this

Trigger a Pipeline with the CircleCI 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 CircleCI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Article trigger
1. Connect your Shopify account
2. Configure timer
3. Select a Blog ID
Configure the Trigger a Pipeline action
1. Connect your CircleCI account
2. Configure alert
3. Configure Project Slug
4. Configure Definition ID
5. Optional- Configure Config Branch
6. Optional- Configure Config Tag
7. Optional- Configure Checkout Branch
8. Optional- Configure Checkout Tag
9. Optional- Configure Parameters
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 Article on Shopify

Description:Emit new event for each new article in a blog.

Version:0.0.7

Key:shopify_developer_app-new-article

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 "@pipedream/shopify/sources/new-article/new-article.mjs";

import { adjustPropDefinitions } from "../../common/utils.mjs";

const {
  name, description, type, ...others
} = common;
const props = adjustPropDefinitions(others.props, shopify);

export default {
  ...others,
  key: "shopify_developer_app-new-article",
  version: "0.0.7",
  name,
  description,
  type,
  props: {
    app: shopify,
    ...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	`app`	`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`
Blog ID	`blogId`	`string`	Select a value from the drop down menu.

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#

Trigger a Pipeline on CircleCI

Description:Trigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun)

Version:0.0.1

Key:circleci-trigger-pipeline

View on GitHub

CircleCI Overview#

The CircleCI API allows for seamless integration and automation of your CI/CD pipeline. By leveraging the API through Pipedream, you can trigger builds, monitor the status of pipelines, fetch build artifacts, and interact with various aspects of your CircleCI projects. This facilitates the creation of dynamic workflows that can streamline development practices, enhance deployment strategies, and ensure continuous integration processes are more efficient and less error-prone.

Action Code#

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

export default {
  key: "circleci-trigger-pipeline",
  name: "Trigger a Pipeline",
  description: "Trigger a pipeline given a pipeline definition ID. Supports all integrations except GitLab. [See the documentation](https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun)",
  version: "0.0.1",
  type: "action",
  props: {
    circleci,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Supports all integrations except GitLab.",
    },
    projectSlug: {
      propDefinition: [
        circleci,
        "projectSlug",
      ],
    },
    definitionId: {
      type: "string",
      label: "Definition ID",
      description: "The unique ID for the pipeline definition. This can be found in the page Project Settings > Pipelines.",
    },
    configBranch: {
      type: "string",
      label: "Config Branch",
      description: "The branch that should be used to fetch the config file. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)",
      optional: true,
    },
    configTag: {
      type: "string",
      label: "Config Tag",
      description: "The tag that should be used to fetch the config file. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.",
      optional: true,
    },
    checkoutBranch: {
      type: "string",
      label: "Checkout Branch",
      description: "The branch that should be used to check out code on a checkout step. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)",
      optional: true,
    },
    checkoutTag: {
      type: "string",
      label: "Checkout Tag",
      description: "The tag that should be used to check out code on a checkout step. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.",
      optional: true,
    },
    parameters: {
      type: "object",
      label: "Parameters",
      description: "An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.circleci.triggerPipeline({
      $,
      projectSlug: this.projectSlug,
      data: {
        definition_id: this.definitionId,
        config: this.configBranch || this.configTag
          ? {
            branch: this.configBranch,
            tag: this.configTag,
          }
          : undefined,
        checkout: this.checkoutBranch || this.checkoutTag
          ? {
            branch: this.checkoutBranch,
            tag: this.checkoutTag,
          }
          : undefined,
        parameters: typeof this.parameters === "string"
          ? JSON.parse(this.parameters)
          : this.parameters,
      },
    });

    if (response?.id) {
      $.export("$summary", `Successfully triggered pipeline with ID: ${response.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
CircleCI	`circleci`	`app`	This component uses the CircleCI app.
Project Slug	`projectSlug`	`string`	Project slug in the form `vcs-slug/org-name/repo-name` (found in Project Settings)
Definition ID	`definitionId`	`string`	The unique ID for the pipeline definition. This can be found in the page Project Settings > Pipelines.
Config Branch	`configBranch`	`string`	The branch that should be used to fetch the config file. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)
Config Tag	`configTag`	`string`	The tag that should be used to fetch the config file. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.
Checkout Branch	`checkoutBranch`	`string`	The branch that should be used to check out code on a checkout step. Note that branch and tag are mutually exclusive. To trigger a pipeline for a PR by number use pull//head for the PR ref or pull//merge for the merge ref (GitHub only)
Checkout Tag	`checkoutTag`	`string`	The tag that should be used to check out code on a checkout step. The commit that this tag points to is used for the pipeline. Note that branch and tag are mutually exclusive.
Parameters	`parameters`	`object`	An object containing pipeline parameters and their values. Pipeline parameters have the following size limits: 100 max entries, 128 maximum key length, 512 maximum value length.

Trigger a Pipeline with CircleCI API on New Article from Shopify API

Pipedream makes it easy to connect APIs for CircleCI, 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