Create Story with Shortcut API on New Order Event (Instant) from WooCommerce API

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

Trigger workflow on

New Order Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Order Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Story action
1. Connect your Shortcut account
2. Configure Archived
3. Optional- Configure Comment
4. Optional- Configure Completed at Override Date
5. Optional- Configure Created at Date
6. Optional- Configure Due Date
7. Optional- Configure Description
8. Optional- Select a Epic ID
9. Optional- Configure Estimate
10. Optional- Configure External Id
11. Optional- Configure External Links
12. Optional- Select one or more File Ids
13. Optional- Select one or more Follower Ids
14. Optional- Select a Iteration Id
15. Optional- Configure Label
16. Optional- Select one or more Linked File Ids
17. Configure Name
18. Optional- Select one or more Owner Ids
19. Select a Project Id
20. Optional- Select a Requested by ID
21. Optional- Configure Started at Override Date
22. Optional- Configure Story Link
23. Optional- Select a Story Type
24. Optional- Configure Task
25. Optional- Configure Updated at Date
26. Optional- Select a Workflow State Id
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 Order Event (Instant) on WooCommerce

Description:Emit new event each time the specified order event(s) occur

Version:0.0.4

Key:woocommerce-new-order-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "woocommerce-new-order-event",
  name: "New Order Event (Instant)",
  description: "Emit new event each time the specified order event(s) occur",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listOrders({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `order.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Order ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
  sampleEmit,
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Story on Shortcut

Description:Creates a new story in your Shortcut account. See [Create Story](https://shortcut.com/api/rest/v3#Create-Story) in Shortcut Rest API, V3 reference for endpoint documentation.

Version:0.0.1

Key:shortcut-create-story

View on GitHub

Shortcut Overview#

The Shortcut (formerly Clubhouse.io) API empowers teams to automate project management tasks, streamline workflows, and integrate with other tools seamlessly. Using the API through Pipedream, you can trigger actions based on project updates, synchronize data across platforms, and manipulate Shortcut resources like stories, epics, and sprints programmatically. This ability to interact with Shortcut entities opens up a plethora of automation possibilities, optimizing the development cycle and communication pathways.

Action Code#

const shortcut = require("../../shortcut.app");
const get = require("lodash/get");
const validate = require("validate.js");
const utils = require("../../utils");
const constants = require("../../constants");

module.exports = {
  key: "shortcut-create-story",
  name: "Create Story",
  description: "Creates a new story in your Shortcut account. See [Create Story](https://shortcut.com/api/rest/v3#Create-Story) in Shortcut Rest API, V3 reference for endpoint documentation.",
  version: "0.0.1",
  type: "action",
  props: {
    shortcut,
    archived: {
      type: "boolean",
      label: "Archived",
      description: "Controls the story's archived state.",
      default: false,
    },
    comment: {
      type: "object",
      label: "Comment",
      description:
        "A comment object attached to the story must have the following structure: `author_id` which is the member ID of the Comment’s author  (defaults to the user identified by the API token), `created_at` which defaults to the time/date the comment is created, but can be set to reflect another date, `external_id` field that can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here, `text` is the comment text, and `updated_at` which defaults to the time/date the comment is last updated in Shortcut but can be set to reflect another time/date. See [CreateStoryCommentParams](https://shortcut.com/api/rest/v3#CreateStoryCommentParams) for more info.",
      optional: true,
    },
    completedAtOverride: {
      type: "string",
      label: "Completed at Override Date",
      description:
        "A manual override for the time/date the Story was completed.",
      optional: true,
    },
    createdAt: {
      type: "string",
      label: "Created at Date",
      description: "The time/date the Story was created.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "The due date of the story.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the story.",
      default: "",
      optional: true,
    },
    epicId: {
      type: "integer",
      label: "Epic ID",
      description: "The unique identifier of the epic the story belongs to.",
      async options() {
        let options = [];
        const epics = await this.shortcut.callWithRetry("listEpics");
        const isEpicDataAvailable = get(epics, [
          "data",
          "length",
        ]);
        if (!isEpicDataAvailable) {
          return options;
        }
        options = epics.data.map((epic) => ({
          label: epic.name,
          value: epic.id,
        }));
        return options;
      },
      optional: true,
    },
    estimate: {
      type: "integer",
      label: "Estimate",
      description:
        "The numeric point estimate of the story. Can also be null, which means unestimated.",
      optional: true,
    },
    externalId: {
      type: "string",
      label: "External Id",
      description:
        "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.",
      optional: true,
    },
    externalLinks: {
      type: "string[]",
      label: "External Links",
      description: "A string array of External Links associated with this story.",
      optional: true,
    },
    fileIds: {
      type: "integer[]",
      label: "File Ids",
      description: "An array of IDs of files attached to the story.",
      async options() {
        let options = [];
        const files = await this.shortcut.callWithRetry("listFiles");
        const isFileDataAvailable = get(files, [
          "data",
          "length",
        ]);
        if (!isFileDataAvailable) {
          return options;
        }
        options = files.data.map((file) => ({
          label: file.name,
          value: file.id,
        }));
        return options;
      },
      optional: true,
    },
    followerIds: {
      type: "string[]",
      label: "Follower Ids",
      description: "A string array of UUIDs of the followers of this story.",
      async options() {
        return await this.shortcut.listMembersAsOptions();
      },
      optional: true,
    },
    iterationId: {
      type: "integer",
      label: "Iteration Id",
      description: "The ID of the iteration the story belongs to.",
      async options() {
        let options = [];
        const iterations = await this.shortcut.callWithRetry("listIterations");
        const isIterationDataAvailable = get(iterations, [
          "data",
          "length",
        ]);
        if (!isIterationDataAvailable) {
          return options;
        }
        options = iterations.data.map((iteration) => ({
          label: iteration.name,
          value: iteration.id,
        }));
        return options;
      },
      optional: true,
    },
    label: {
      type: "object",
      label: "Label",
      description:
        "A label object attached to the story. Each label object must have the following structure: `color` which is an string with the hex color to be displayed with the Label i.e. \"#ff0000\", and a string `name` for the name of the Label. See [CreateLabelParams](https://shortcut.com/api/rest/v3#CreateLabelParams) for more info.",
      optional: true,
    },
    linkedFileIds: {
      type: "integer[]",
      label: "Linked File Ids",
      description:
        "An array of IDs of linked files attached to the story.",
      async options() {
        let options = [];
        const linkedFiles = await this.shortcut.callWithRetry("listLinkedFiles");
        const isLinkedFilesDataAvailable = get(linkedFiles, [
          "data",
          "length",
        ]);
        if (!isLinkedFilesDataAvailable) {
          return options;
        }
        options = linkedFiles.data.map((linkedFile) => ({
          label: linkedFile.name,
          value: linkedFile.id,
        }));
        return options;
      },
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the story.",
    },
    ownerIds: {
      type: "string[]",
      label: "Owner Ids",
      description: "A string array of UUIDs of the owners of this story.",
      async options() {
        return await this.shortcut.listMembersAsOptions();
      },
      optional: true,
    },
    projectId: {
      type: "integer",
      label: "Project Id",
      description: "The ID of the project the story belongs to.",
      async options() {
        let options = [];
        const projects = await this.shortcut.callWithRetry("listProjects");
        const isProjectDataAvailable = get(projects, [
          "data",
          "length",
        ]);
        if (!isProjectDataAvailable) {
          return options;
        }
        options = projects.data.map((project) => ({
          label: project.name,
          value: project.id,
        }));
        return options;
      },
    },
    requestedById: {
      type: "string",
      label: "Requested by ID",
      description: "The ID of the member that requested the story.",
      async options() {
        return await this.shortcut.listMembersAsOptions();
      },
      optional: true,
    },
    startedAtOverride: {
      type: "string",
      label: "Started at Override Date",
      description: "A manual override for the time/date the Story was started.",
      optional: true,
    },
    storyLink: {
      type: "object",
      label: "Story Link",
      description:
        "An story link object attached to the story must have the following structure: `object_id` is the unique ID of the story defined as object, `subject_id` is the unique ID of the story defined as subject, and `verb` which indicates how the subject story acts on the object story, valid values are `blocks`, `duplicates`, or `relates to`. See [CreateStoryLinkParams](https://shortcut.com/api/rest/v3#CreateStoryLinkParams) for more info.",
      optional: true,
    },
    storyType: {
      type: "string",
      label: "Story Type",
      description: "The type of story (feature, bug, chore).",
      options: constants.STORY_TYPES,
      default: "feature",
      optional: true,
    },
    task: {
      type: "object",
      label: "Task",
      description:
        "A task object attached to the story must have the following structure: `complete` which is a boolean, indicating whether the task is completed (defaults to `false`), `created_at` which defaults to the time/date the task is created but can be set to reflect another creation time/date, `description` as a description for the task, `external_id` a field can be set to another unique ID. In the case that the task has been imported from another tool, the ID in the other tool can be indicated here, `owner_ids` as an array of UUIDs for any members you want to add as owners on this new task, `updated_at` which defaults to the time/date the task was last updated in Shortcut but can be set to reflect another time/date. See [CreateTaskParams](https://shortcut.com/api/rest/v3#CreateTaskParams) for more info.",
      optional: true,
    },
    updatedAt: {
      type: "string",
      label: "Updated at Date",
      description: "The time/date the story was updated.",
      optional: true,
    },
    workflowStateId: {
      type: "integer",
      label: "Workflow State Id",
      description: "The ID of the workflow state the story will be in.",
      async options() {
        let options = [];
        const workflows = await this.shortcut.callWithRetry("listWorkflows");
        const isWorkflowDataAvailable = get(workflows, [
          "data",
          "length",
        ]);
        if (!isWorkflowDataAvailable) {
          return options;
        }
        return workflows.data.reduce(function (options, workflow) {
          const hasState = get(workflow, [
            "states",
            "length",
          ]);
          if (!hasState) {
            return options;
          }
          const optionsToAdd = workflow.states.map((state) => ({
            label: `${state.name} (${workflow.name})`,
            value: `${state.id}`,
          }));
          return options.concat(optionsToAdd);
        }, []);
      },
      optional: true,
    },
  },
  async run() {
    const constraints = {
      name: {
        length: {
          maximum: 512,
        },
      },
      description: {
        length: {
          maximum: 100000,
        },
      },
      externalLinks: utils.validateArrayWhenPresent,
      fileIds: utils.validateArrayWhenPresent,
      followerIds: utils.validateArrayWhenPresent,
      inkedFileIds: utils.validateArrayWhenPresent,
      ownerIds: utils.validateArrayWhenPresent,
    };
    const validationResult = validate(
      {
        name: this.name,
        description: this.description,
        externalLinks: this.externalLinks,
        fileIds: this.fileIds,
        followerIds: this.followerIds,
        linkedFileIds: this.linkedFileIds,
        ownerIds: this.ownerIds,
      },
      constraints,
    );
    utils.checkValidationResults(validationResult);
    const story = {
      archived: this.archived,
      completed_at_override: this.completedAtOverride,
      created_at: this.createdAt,
      deadline: this.dueDate,
      description: this.description,
      epic_id: this.epicId,
      estimate: this.estimate,
      external_id: this.externalId,
      external_links: this.externalLinks,
      file_ids: this.fileIds,
      follower_ids: this.followerIds,
      iteration_id: this.iterationId,
      linked_file_ids: this.linkedFileIds,
      name: this.name,
      owner_ids: this.ownerIds,
      project_id: this.projectId,
      requested_by_id: this.requestedById,
      started_at_override: this.startedAtOverride,
      story_type: this.storyType,
      updated_at: this.updatedAt,
      workflow_state_id: this.workflowStateId,
    };
    const comment = utils.convertEmptyStringToUndefined(this.comment);
    if (comment) {
      story.comments = [
        comment,
      ];
    }
    const label = utils.convertEmptyStringToUndefined(this.label);
    if (label) {
      story.labels = [
        label,
      ];
    }
    const storyLink = utils.convertEmptyStringToUndefined(this.storyLink);
    if (storyLink) {
      story.story_links = [
        storyLink,
      ];
    }
    const task = utils.convertEmptyStringToUndefined(this.task);
    if (task) {
      story.tasks = [
        task,
      ];
    }
    const resp = await this.shortcut.callWithRetry("createStory", story);
    return resp.data;
  },
};

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
Shortcut	`shortcut`	`app`	This component uses the Shortcut app.
Archived	`archived`	`boolean`	Controls the story's archived state.
Comment	`comment`	`object`	A comment object attached to the story must have the following structure: `author_id` which is the member ID of the Comment’s author (defaults to the user identified by the API token), `created_at` which defaults to the time/date the comment is created, but can be set to reflect another date, `external_id` field that can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here, `text` is the comment text, and `updated_at` which defaults to the time/date the comment is last updated in Shortcut but can be set to reflect another time/date. See CreateStoryCommentParams for more info.
Completed at Override Date	`completedAtOverride`	`string`	A manual override for the time/date the Story was completed.
Created at Date	`createdAt`	`string`	The time/date the Story was created.
Due Date	`dueDate`	`string`	The due date of the story.
Description	`description`	`string`	The description of the story.
Epic ID	`epicId`	`integer`	Select a value from the drop down menu.
Estimate	`estimate`	`integer`	The numeric point estimate of the story. Can also be null, which means unestimated.
External Id	`externalId`	`string`	This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.
External Links	`externalLinks`	`string[]`	A string array of External Links associated with this story.
File Ids	`fileIds`	`integer[]`	Select a value from the drop down menu.
Follower Ids	`followerIds`	`string[]`	Select a value from the drop down menu.
Iteration Id	`iterationId`	`integer`	Select a value from the drop down menu.
Label	`label`	`object`	A label object attached to the story. Each label object must have the following structure: `color` which is an string with the hex color to be displayed with the Label i.e. "#ff0000", and a string `name` for the name of the Label. See CreateLabelParams for more info.
Linked File Ids	`linkedFileIds`	`integer[]`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the story.
Owner Ids	`ownerIds`	`string[]`	Select a value from the drop down menu.
Project Id	`projectId`	`integer`	Select a value from the drop down menu.
Requested by ID	`requestedById`	`string`	Select a value from the drop down menu.
Started at Override Date	`startedAtOverride`	`string`	A manual override for the time/date the Story was started.
Story Link	`storyLink`	`object`	An story link object attached to the story must have the following structure: `object_id` is the unique ID of the story defined as object, `subject_id` is the unique ID of the story defined as subject, and `verb` which indicates how the subject story acts on the object story, valid values are `blocks`, `duplicates`, or `relates to`. See CreateStoryLinkParams for more info.
Story Type	`storyType`	`string`	Select a value from the drop down menu:`bugchorefeature`
Task	`task`	`object`	A task object attached to the story must have the following structure: `complete` which is a boolean, indicating whether the task is completed (defaults to `false`), `created_at` which defaults to the time/date the task is created but can be set to reflect another creation time/date, `description` as a description for the task, `external_id` a field can be set to another unique ID. In the case that the task has been imported from another tool, the ID in the other tool can be indicated here, `owner_ids` as an array of UUIDs for any members you want to add as owners on this new task, `updated_at` which defaults to the time/date the task was last updated in Shortcut but can be set to reflect another time/date. See CreateTaskParams for more info.
Updated at Date	`updatedAt`	`string`	The time/date the story was updated.
Workflow State Id	`workflowStateId`	`integer`	Select a value from the drop down menu.