How we empower our users with Webhooks and APIs
Building tools for other engineering-focused companies means that we are developing (and continuously deploying!) for companies facing many of the same challenges that we do. Having a highly technical user base also means that we can enable the people closest to the problems to craft their own innovative solutions, and one of the ways that we do that is through our extensive public API and related documentation.
The public API was no afterthought. Shortcut’s web and forthcoming mobile frontends are the primary consumers of the Shortcut REST API, and V1 of our public API was released concurrently with our public launch. In developing our industry-leading integrations, we came to further appreciate the value of a well-documented and maintained public API.
We’ve continued to iterate on the API, taking in feedback and doing our best to expose any potentially useful new endpoints in our beta version in order to enable our users to do handy things like migrate data from other project management systems, set-up reporting applications, and integrate with applications that are mission-critical to their organizations. Over the years, several engineers have used and shared open source libraries built with the Shortcut API, and we've made them available on our Open Source Projects page.
The Shortcut API page is where you will find API and webhook documentation.
In order to keep putting the tools in the hands of the people that need them most, we recently released v2 of our REST API, adding endpoints for features such as Teams, Milestones, and Categories. You can check out the new version of the REST API here.
The ingenuity evident in our customer base also encouraged us to make a generic outgoing webhook available to our users. With this new webhook, applications no longer need to continuously ping the API for changes. Instead, all updates will be posted to the URL of your choice. Possible uses for the webhook include:
- Reporting applications
- 3rd party-integrations
- Custom Slack messages
We are excited by all we have seen you and your teammates discover and create, and we look forward to making more developer tools available in the future.
In the meantime, we’d love to hear how the Shortcut API and/or Webhook has been useful to you and your company - let us know on Twitter.