Setting up Outgoing Webhooks

webhooks.png

Outgoing webhooks can be used to gather organization information and integrate with external services. Once configured, events will fire to the URL(s) of your choice and can be used to create applications for various purposes, such as notifications and reporting.

Developer documentation for our webhooks can be found here.

How to Enable Shortcut Webhooks

Click the gear wheel in the upper right-hand corner of any Shortcut page. Navigate to "Integrations" and click on "Webhooks."

integrations-webhooks.png

From the Webhook dialogue, click Add New Webhook, you will be asked to provide a Payload URL.

add-new-webhook.png

Setting the Payload URL

You will need to set distinct URL for the webhook to send events to, it can be any URL you wish. Webhook data is sent as JSON in the POST request body. The events that are sent to the webhook are outlined in the developer documentation

Setting a Secret API Token

Setting a secret API token is optional, but if you chose to do so,  Shortcut will use it to create a hash signature with each payload that is passed along in the Shortcut-Signature header. Shortcut uses an HMAC hexdigest to compute the hash.

Please refer to our developer documentation for additional information such as webhook formats and example use cases.

 

Updated

Was this article helpful?

1 out of 2 found this helpful

Have more questions? Submit a request