View as Markdown
Shortcut icon

Shortcut ACTION

Create Story

Creates a new story in your Shortcut account. See Create Story in Shortcut Rest API, V3 reference for endpoint documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shortcut account once, then configure and run Create Story from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "shortcut-create-story",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shortcut: { authProvisionId: "apn_xxxxxxx" },
    workflowStateId: 10,
    name: "Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Story inputs
Property Type Description
workflowStateId Workflow State ID integer
The ID of the workflow state the story will be in
Required Dynamic
name Name string
The name of the story
Required
archived Archived boolean
Controls the story's archived state
Optional
comment Comment string
A comment to attach to the story
Optional
completedAtOverride Completed at Override Date string
A manual override for the time/date the Story was completed
Optional
createdAt Created at Date string
The time/date the Story was created
Optional
dueDate Due Date string
The due date of the story
Optional
description Description string
The description of the story
Optional
epicId Epic ID integer
The unique identifier of the epic the story belongs to
Optional Dynamic
estimate Estimate integer
The numeric point estimate of the story. Can also be null, which means unestimated
Optional
externalId External ID 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.
Optional
externalLinks External Links string[]
A string array of External Links associated with this story
Optional
fileIds File IDs integer[]
An array of IDs of files attached to the story
Optional Dynamic
followerIds Follower IDs string[]
A string array of UUIDs of the followers of this story
Optional Dynamic
iterationId Iteration ID integer
The ID of the iteration the story belongs to
Optional Dynamic
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.
Optional
linkedFileIds Linked File IDs integer[]
An array of IDs of linked files attached to the story.
Optional Dynamic
ownerIds Owner IDs string[]
A string array of UUIDs of the owners of this story
Optional Dynamic
requestedById Requested by ID string
The ID of the member that requested the story
Optional Dynamic
startedAtOverride Started at Override Date string
A manual override for the time/date the Story was started
Optional
storyIds Story IDs integer[]
The IDs of stories to link as related to the new story
Optional Dynamic
storyType Story Type string
The type of story (feature, bug, chore)
Optional
tasks Tasks string[]
An array of task descriptions to add to the story
Optional
updatedAt Updated at Date string
The time/date the story was updated
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
shortcut-create-story
Version
1.0.2
App
Shortcut
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes