Skip to main content

​
Prerequisites

Before continuing, you should have already completed the following for this connector:
1

Configure the Connector

Enable the connector and set up its connector profile in your project. See Managing Connectors.

Connector Profile

Shortcut - API Key
2

Link an Account

Connect an account using StackOne Hub or Auth Link.

Link Account

Shortcut - API Key

​
How webhooks are set up

When the account is connected, StackOne registers a single workspace-wide Outgoing Webhook in Shortcut and removes it automatically on disconnect. Shortcut does not support subscribing to individual event types — the one registration receives every change the workspace fires — so StackOne groups events by resource: enabling a resource-level event below delivers ALL of that resource’s changes (create, update, and delete), with the concrete change type carried in each delivered event (for example story.create, story.update, or story.delete).

​
Available webhook events

Each event below covers the full create/update/delete family of its resource.

1

Core events

Shortcut fires webhooks for Stories and Epics, including their comments and tasks.

  • Story Events — story.create / story.update / story.delete (updates include workflow-state moves, owners, labels, iterations, and estimates).
  • Epic Events — epic.create / epic.update / epic.delete.
  • Story Comment Events — story-comment.create / story-comment.update / story-comment.delete.
  • Story Task Events — story-task.create / story-task.update / story-task.delete.
  • Epic Comment Events — epic-comment.create / epic-comment.update / epic-comment.delete.
2

Catch-all

A safety net so no delivery is lost.

  • Other Events — any delivery whose entity type is not covered above, such as threaded comments, VCS integration events (branches and pull requests from a connected GitHub, GitLab, or Bitbucket), or a type Shortcut introduces in the future; the delivered event carries the real type.

​
Delivery notes

How Shortcut delivers events to StackOne.

1

Key points

What to expect from delivered events.

  • Shortcut deliveries carry no event-name field — StackOne derives the event type from the primary action’s entity type and verb (entity_type + ”.” + action, e.g. story.update).
  • Each delivery contains an actions array (what changed) and a references array (related entities); the full envelope is forwarded in the event data.
  • Other entities (labels, iterations, objectives, categories, projects, docs) never fire webhooks of their own — they appear inside story and epic events.
  • Rapid changes made in quick succession are merged into fewer deliveries, so one event can carry several related changes.
  • Deliveries are signed with HMAC-SHA-256 (Payload-Signature header) using a secret StackOne registers automatically — no manual verification needed.

​
Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.