Create Article with Craftboxx API on New Event Emitted (Instant) from Shopify API

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

Trigger workflow on

New Event Emitted (Instant) from the Shopify API

Next, do this

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

Select this integration
Configure the New Event Emitted (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
4. Select a Event Topic
Configure the Create Article action
1. Connect your Craftboxx account
2. Configure Name
3. Optional- Configure Manufacturer
4. Optional- Configure Manufacturer Article Number
5. Optional- Configure EAN
6. Optional- Configure Supplier Article Number
7. Optional- Configure Unit Price
8. Optional- Select a Currency
9. Optional- Configure VAT Rate
10. Optional- Configure VAT Included
11. Optional- Select a Unit
12. Optional- Configure Price Date
13. Optional- Configure Article URL
14. Optional- Configure Info
15. Optional- Configure Dangerous Material
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 Event Emitted (Instant) on Shopify

Description:Emit new event for each new Shopify event.

Version:0.0.4

Key:shopify_developer_app-new-event-emitted

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-event-emitted",
  name: "New Event Emitted (Instant)",
  type: "source",
  description: "Emit new event for each new Shopify event.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    ...common.props,
    topic: {
      type: "string",
      label: "Event Topic",
      description: "Event topic that triggers the webhook.",
      options: constants.EVENT_TOPICS,
    },
  },
  methods: {
    ...common.methods,
    getTopic() {
      return this.topic;
    },
    generateMeta() {
      const ts = Date.now();
      return {
        id: ts,
        summary: `New Event Emitted at ${new Date(ts)}.`,
        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`.
Event Topic	`topic`	`string`	Select a value from the drop down menu:`app/uninstalledbulk_operations/finishcarts/createcarts/updatecheckouts/createcheckouts/deletecheckouts/updatecollection_listings/addcollection_listings/removecollection_listings/updatecollections/createcollections/deletecollections/updatecustomer_groups/createcustomer_groups/deletecustomer_groups/updatecustomer_payment_methods/createcustomer_payment_methods/revokecustomer_payment_methods/updatecustomers_marketing_consent/updatecustomers/createcustomers/deletecustomers/disablecustomers/enablecustomers/updatedisputes/createdisputes/updatedomains/createdomains/destroydomains/updatedraft_orders/createdraft_orders/deletedraft_orders/updatefulfillment_events/createfulfillment_events/deletefulfillments/createfulfillments/updateinventory_items/createinventory_items/deleteinventory_items/updateinventory_levels/connectinventory_levels/disconnectinventory_levels/updatelocales/createlocales/updatelocations/createlocations/deletelocations/updatemarkets/createmarkets/deletemarkets/updateorder_transactions/createorders/cancelledorders/createorders/deleteorders/editedorders/fulfilledorders/paidorders/partially_fulfilledorders/updatedproduct_listings/addproduct_listings/removeproduct_listings/updateproducts/createproducts/deleteproducts/updateprofiles/createprofiles/deleteprofiles/updaterefunds/createscheduled_product_listings/addscheduled_product_listings/removescheduled_product_listings/updateselling_plan_groups/createselling_plan_groups/deleteselling_plan_groups/updateshop/updatesubscription_billing_attempts/challengedsubscription_billing_attempts/failuresubscription_billing_attempts/successsubscription_contracts/createsubscription_contracts/updatetender_transactions/createthemes/createthemes/deletethemes/publishevent-topics-themes-updatethemes/update`

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 Article on Craftboxx

Description:Creates a new article in Craftboxx. [See the documentation](https://api.craftboxx.de/docs/docs.json)

Version:0.0.1

Key:craftboxx-create-article

View on GitHub

Craftboxx Overview#

The Craftboxx API allows users to integrate various features of the Craftboxx project management solution into their workflows. With this API, you can automate tasks related to project planning, resource allocation, time tracking, and document management. On Pipedream, you can tap into the Craftboxx API to create customized, serverless workflows that respond to events in real time. This enables businesses to streamline operations, reduce manual data entry, and improve coordination between teams.

Action Code#

import app from "../../craftboxx.app.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "craftboxx-create-article",
  name: "Create Article",
  description: "Creates a new article in Craftboxx. [See the documentation](https://api.craftboxx.de/docs/docs.json)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the article",
    },
    manufacturer: {
      type: "string",
      label: "Manufacturer",
      description: "The manufacturer of the article",
      optional: true,
    },
    manufacturerArticleNr: {
      type: "string",
      label: "Manufacturer Article Number",
      description: "The manufacturer article number of the article",
      optional: true,
    },
    ean: {
      type: "string",
      label: "EAN",
      description: "The EAN of the article",
      optional: true,
    },
    supplierArticleNr: {
      type: "string",
      label: "Supplier Article Number",
      description: "The supplier article number of the article",
      optional: true,
    },
    unitPrice: {
      type: "string",
      label: "Unit Price",
      description: "The price of the article. Eg. `2.5`",
      optional: true,
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "The currency of the article",
      optional: true,
      options: constants.CURRENCIES,
    },
    vatRate: {
      type: "string",
      label: "VAT Rate",
      description: "The VAT rate of the article. Eg. `19`",
      optional: true,
    },
    vatIncluded: {
      type: "boolean",
      label: "VAT Included",
      description: "Whether the price is VAT included",
      optional: true,
    },
    unit: {
      type: "string",
      label: "Unit",
      description: "The unit of the article",
      optional: true,
      options: constants.UNITS,
    },
    priceDate: {
      type: "string",
      label: "Price Date",
      description: "The date of the price. Eg. `2024-04-21`",
      optional: true,
    },
    articleUrl: {
      type: "string",
      label: "Article URL",
      description: "The URL of the article",
      optional: true,
    },
    info: {
      type: "string",
      label: "Info",
      description: "The description of the article",
      optional: true,
    },
    dangerousMaterial: {
      type: "boolean",
      label: "Dangerous Material",
      description: "Whether the article is dangerous material",
      optional: true,
    },
  },
  methods: {
    createArticle(args = {}) {
      return this.app.post({
        path: "/articles",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createArticle,
      ...data
    } = this;

    const response = await createArticle({
      $,
      data: utils.keysToSnakeCase(data),
    });

    $.export("$summary", `Successfully created article with ID \`${response.data.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
Craftboxx	`app`	`app`	This component uses the Craftboxx app.
Name	`name`	`string`	The name of the article
Manufacturer	`manufacturer`	`string`	The manufacturer of the article
Manufacturer Article Number	`manufacturerArticleNr`	`string`	The manufacturer article number of the article
EAN	`ean`	`string`	The EAN of the article
Supplier Article Number	`supplierArticleNr`	`string`	The supplier article number of the article
Unit Price	`unitPrice`	`string`	The price of the article. Eg. `2.5`
Currency	`currency`	`string`	Select a value from the drop down menu:`EURUSDCHF`
VAT Rate	`vatRate`	`string`	The VAT rate of the article. Eg. `19`
VAT Included	`vatIncluded`	`boolean`	Whether the price is VAT included
Unit	`unit`	`string`	Select a value from the drop down menu:`BAGBARBOTTLEBOXBUCKETBUNCHCANECANISTERCARDBOARDCUBIC_METRECENTIMETERSDAYSDOZENFLAT_FEEGRAMSHOURSKILOGRAMSKILOMETERKILOWATT_PEAKLITREMETRESMILLILITREMILLIMETRESPACKPAIRPANELPARCELPERCENTPIECEROLLRUNNING_METERSACSETSQUAREMETERTONSTRIMMINGTUBE`
Price Date	`priceDate`	`string`	The date of the price. Eg. `2024-04-21`
Article URL	`articleUrl`	`string`	The URL of the article
Info	`info`	`string`	The description of the article
Dangerous Material	`dangerousMaterial`	`boolean`	Whether the article is dangerous material

Action Authentication#

Craftboxx uses OAuth authentication. When you connect your Craftboxx account, Pipedream will open a popup window where you can sign into Craftboxx and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Craftboxx API.

Pipedream requests the following authorization scopes when you connect your account:

Create Article with Craftboxx API on New Event Emitted (Instant) from Shopify API

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