Beyond-Bot.ai + Shortcut

Shortcut aligns product development work with company objectives so teams can execute with a shared purpose.

What You Can Do with this Integration

Automate Data Entry

Automatically sync new contacts or deals from Beyond-Bot.ai to Shortcut.

Enrich Customer Profiles

Use Beyond-Bot.ai to find and add new information to your records in Shortcut.

Trigger Workflows

Start automated workflows in Shortcut based on conversations with your virtual expert.

Available Actions

Here are the specific actions your virtual expert can perform within Shortcut.

Create Category

Create category allows you to create a new category in shortcut.

Create Entity Template

Create a new entity template for the workspace.

Create Epic

Create epic allows you to create a new epic in shortcut.

Create Epic Comment

This endpoint allows you to create a threaded comment on an epic.

Create Epic Comment Comment

This endpoint allows you to create a nested comment reply to an existing epic comment.

Create Group

Creates a new group in the shortcut system with customizable properties. this endpoint allows you to set up a group with a unique mention name, display name, optional description, and various customization options. use this when you need to establish a new team, department, or any other collective within your shortcut workspace. the created group can include members, associated workflows, and visual customizations like color and icon. this endpoint is particularly useful for organizing your shortcut workspace structure, facilitating team collaboration, and streamlining workflow management. note that while member and workflow associations can be set during creation, they can also be modified later using separate endpoints.

Create Iteration

The createiteration endpoint allows you to create a new iteration in shortcut, which represents a time-boxed period for completing a set of stories or tasks. this endpoint is crucial for teams using agile methodologies, enabling them to plan and track progress over specific time periods. use this endpoint when setting up sprint cycles, planning releases, or organizing work into manageable timeframes. the endpoint requires essential information such as the iteration's name and date range, while also offering options to add followers, associate groups, and attach labels for better organization and tracking. it's important to note that while multiple groups can be added via the api, the current web ui only displays one group association. this endpoint should not be used for modifying existing iterations; instead, use the dedicated update endpoint for such changes.

Create Label

Create label allows you to create a new label in shortcut.

Create Linked File

Create linked file allows you to create a new linked file in shortcut.

Create Milestone

(deprecated: use 'create objective') create milestone allows you to create a new milestone in shortcut.

Create Multiple Stories

Create multiple stories allows you to create multiple stories in a single request using the same syntax as [create story](https://developer.shortcut.com/api/rest/v3#create-story).

Create Objective

Create objective allows you to create a new objective in shortcut.

Create Project

Create project is used to create a new shortcut project.

Create Story

Create story is used to add a new story to your shortcut workspace. this endpoint requires that either **workflow state id** or **project id** be provided, but will reject the request if both or neither are specified. the workflow state id has been marked as required and is the recommended field to specify because we are in the process of sunsetting projects in shortcut.

Create Story Comment

Create comment allows you to create a comment on any story.

Create Story From Template

Create story from template is used to add a new story derived from a template to your shortcut workspace.

Create Story Link

Story links (called story relationships in the ui) allow you create semantic relationships between two stories. the parameters read like an active voice grammatical sentence: subject -> verb -> object. the subject story acts on the object story; the object story is the direct object of the sentence. the subject story "blocks", "duplicates", or "relates to" the object story. examples: - "story 5 blocks story 6” -- story 6 is now "blocked" until story 5 is moved to a done workflow state. - "story 2 duplicates story 1” -- story 2 represents the same body of work as story 1 (and should probably be archived). - "story 7 relates to story 3”

Create Story Reaction

Create a reaction to a story comment.

Create Task

Create task is used to create a new task in a story.

Delete Category

Delete category can be used to delete any category.

Delete Custom Field

Deletes a specific custom field from the shortcut system using its unique public identifier. this endpoint should be used when you need to permanently remove a custom field that is no longer required in your workflows or project structure. it's important to note that this operation is irreversible, and once a custom field is deleted, all data associated with it will be lost. use this endpoint with caution, ensuring that the custom field is no longer needed and that its deletion won't negatively impact any existing processes or data integrity within your shortcut instance.

Delete Entity Template

Deletes a specific entity template from the shortcut api. this endpoint should be used when you need to permanently remove a template that is no longer needed or is obsolete. it's important to note that this operation cannot be undone, so it should be used with caution. the deletion is performed on a single template identified by its public id, adhering to the best practice of controlling deletion on a per-resource basis. this endpoint is part of the api v3, which may include enhanced features or changes compared to previous versions.

Delete Epic

Delete epic can be used to delete the epic. the only required parameter is epic id.

Delete Epic Comment

This endpoint allows you to delete a comment from an epic.

Delete File

Delete file deletes a previously uploaded file.

Delete Iteration

Deletes a specific iteration from the shortcut project management system. this endpoint should be used when you need to permanently remove an iteration and all its associated data from your project workflow. it's particularly useful for cleaning up completed or cancelled iterations that are no longer needed. be cautious when using this endpoint, as the deletion is irreversible and will remove all data associated with the specified iteration. ensure you have the correct iteration id before proceeding with the deletion to avoid unintended data loss.

Delete Label

Delete label can be used to delete any label.

Delete Linked File

Delete linked file can be used to delete any previously attached linked-file.

Delete Milestone

(deprecated: use 'delete objective') delete milestone can be used to delete any milestone.

Delete Multiple Stories

Delete multiple stories allows you to delete multiple archived stories at once.

Delete Objective

Delete objective can be used to delete any objective.

Delete Project

Delete project can be used to delete a project. projects can only be deleted if all associated stories are moved or deleted. in the case that the project cannot be deleted, you will receive a 422 response.

Delete Story

Delete story can be used to delete any story.

Delete Story Comment

Delete a comment from any story.

Delete Story Link

Removes the relationship between the stories for the given story link.

Delete Story Reaction

Delete a reaction from any story comment.

Delete Task

Delete task can be used to delete any previously created task on a story.

Disable Iterations

Disables iterations for the current workspace

Disable Story Templates

Disables the story template feature for the workspace.

Enable Iterations

Enables iterations for the current workspace

Enable Story Templates

Enables the story template feature for the workspace.

Get Category

Get category returns information about the selected category.

Get Current Member Info

Returns information about the authenticated member.

Get Custom Field

Retrieves detailed information about a specific custom field in shortcut using its unique public identifier. this endpoint allows developers to fetch the properties and configuration of a custom field, which can include its name, type, possible values, and any other associated metadata. it's particularly useful when you need to inspect or validate a custom field's settings programmatically, or when integrating custom field data into external systems. the endpoint should be used when detailed information about a single custom field is required, rather than for bulk operations or listing all custom fields. note that this endpoint only provides read access to custom field data and cannot be used to modify the custom field.

Get Entity Template

Get entity template returns information about a given entity template.

Get Epic

Get epic returns information about the selected epic.

Get Epic Comment

This endpoint returns information about the selected epic comment.

Get Epic Workflow

Returns the epic workflow for the workspace.

Get External Link Stories

Get stories which have a given external link associated with them.

Get File

Get file returns information about the selected uploadedfile.

Get Group

Retrieves detailed information about a specific group in the shortcut workspace using its unique public identifier. this endpoint allows developers to fetch comprehensive data about a group, including its name, type, and associated metadata. it's particularly useful when you need to access or verify group details programmatically, such as during workflow automations or when building integrations that involve group management. the endpoint provides more granular control and information compared to what's available through the web application, making it valuable for advanced group-related operations and data analysis within your shortcut projects.

Get Iteration

Retrieves detailed information about a specific iteration in the shortcut project management system. this endpoint allows users to fetch comprehensive data about a single iteration, including its name, status, start and end dates, associated stories, and progress metrics. it should be used when detailed information about a particular iteration is needed, such as during sprint planning, progress tracking, or retrospective analysis. the endpoint provides a snapshot of the iteration at the time of the request and does not include real-time updates. it's particularly useful for project managers, scrum masters, and team members who need to review or report on iteration-specific data. note that this endpoint only retrieves information and does not allow for modification of the iteration details.

Get Key Result

Get key result returns information about a chosen key result.

Get Label

Get label returns information about the selected label.

Get Linked File

Get file returns information about the selected linked file.

Get Member

Returns information about a member.

Get Milestone

(deprecated: use 'get objective') get milestone returns information about a chosen milestone.

Get Objective

Get objective returns information about a chosen objective.

Get Project

Get project returns information about the selected project.

Get Repository

Get repository returns information about the selected repository.

Get Story

Get story returns information about a chosen story.

Get Story Comment

Get comment is used to get comment information.

Get Story Link

Returns the stories and their relationship for the given story link.

Get Task

Returns information about a chosen task.

Get Workflow

Get workflow returns information about a chosen workflow.

List Categories

List categories returns a list of all categories and their attributes.

List Category Milestones

List category milestones returns a list of all milestones with the category.

List Category Objectives

Returns a list of all objectives with the category.

List Custom Fields

Retrieves a list of all custom fields defined in the shortcut api. this endpoint allows developers to fetch information about user-defined fields that have been added to extend the functionality of standard fields in integrations. it's particularly useful when you need to understand the structure and types of custom data being used across the system. the endpoint returns details about each custom field, which may include their identifiers, names, types, and any associated metadata. use this endpoint when you need to inventory existing custom fields, prepare for data migrations, or dynamically adjust your application's data model to accommodate custom fields. note that this endpoint does not create, modify, or delete custom fields; it's purely for retrieval of existing custom field definitions.

List Entity Templates

List all the entity templates for the workspace.

List Epic Comments

Get a list of all comments on an epic.

List Epics

List epics returns a list of all epics and their attributes.

List Epic Stories

Get a list of all stories in an epic.

List Files

List files returns a list of all uploadedfiles in the workspace.

List Groups

A group in our api maps to a "team" within the shortcut product. a team is a collection of users that can be associated to stories, epics, and iterations within shortcut.

List Group Stories

List the stories assigned to the group. (by default, limited to 1,000).

List Iterations

Retrieves a list of all iterations in the shortcut project management system. iterations represent specific time periods for planning and tracking work, allowing teams to organize their development cycles. this endpoint provides comprehensive information about each iteration, including its name, start and end dates, status, and associated stories or tasks. use this endpoint when you need an overview of all iterations for project planning, progress tracking, or reporting purposes. it's particularly useful for analyzing past performance, planning future sprints, or getting a high-level view of the project timeline. note that the response may be paginated for projects with a large number of iterations, and you might need to make multiple requests to retrieve the full dataset.

List Iteration Stories

Get a list of all stories in an iteration.

List Label Epics

List all of the epics with the label.

List Labels

List labels returns a list of all labels and their attributes.

List Label Stories

List all of the stories with the label.

List Linked Files

List linked files returns a list of all linked-files and their attributes.

List Members

Returns information about members of the workspace.

List Milestone Epics

(deprecated: use 'list objective epics') list all of the epics within the milestone.

List Milestones

(deprecated: use 'list objectives') list milestones returns a list of all milestones and their attributes.

List Objective Epics

List all of the epics within the objective.

List Objectives

List objectives returns a list of all objectives and their attributes.

List Projects

List projects returns a list of all projects and their attributes.

List Repositories

List repositories returns a list of all repositories and their attributes.

List Stories

List stories returns a list of all stories in a selected project and their attributes.

List Story Comment

Lists comments associated with a story

List Workflows

Returns a list of all workflows in the workspace.

Search

Search lets you search epics and stories based on desired parameters. since ordering of the results can change over time (due to search ranking decay, new epics and stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Epics

Search epics lets you search epics based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new epics being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Iterations

Search iterations lets you search iterations based on desired parameters. since ordering of results can change over time (due to search ranking decay, new iterations being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Milestones

Search milestones lets you search milestones based on desired parameters. since ordering of results can change over time (due to search ranking decay, new milestones being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Objectives

Search objectives lets you search objectives based on desired parameters. since ordering of results can change over time (due to search ranking decay, new objectives being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Stories

Search stories lets you search stories based on desired parameters. since ordering of stories can change over time (due to search ranking decay, new stories being created), the `next` value from the previous response can be used as the path and query string for the next page to ensure stable ordering.

Search Stories Old

Search stories lets you search stories based on desired parameters.

Story History

Retrieves the complete history of changes for a specific story in the shortcut project management system. this endpoint allows users to track all modifications, updates, and revisions made to a story over time, providing a comprehensive timeline of its evolution. it's particularly useful for project managers, team members, and stakeholders who need to understand how a story has changed, who made the changes, and when they occurred. the endpoint returns a chronological list of all events and modifications associated with the specified story, helping teams maintain transparency and accountability in their project workflows. note that this endpoint focuses solely on the history of a single story and does not provide information about related stories or overall project status.