App Webhooks Tutorial (public beta)

Last updated 12 July 2017

Introduction

This tutorial walks you through subscribing to an app webhook that notifies you whenever your Heroku app is deployed.

After you complete the tutorial, see the full webhooks documentation for more information on subscribing to webhooks and supported event types.

Step 1: Set up Webhooks Viewer

The Webhooks Viewer sample app provides an easy way to view webhook notifications as they’re sent. Deploy the Webhooks Viewer app with this Heroku Button:

If you aren’t logged in or don’t have a Heroku account, you’ll progress through the login flow before deploying.

When you reach the setup page for the app, scroll down and click Deploy. There’s no need to change any of the app’s settings.

After your app is successfully deployed, all of the checkboxes below the Deploy button turn green:

Now, click View to open the Webhooks Viewer app:

Follow the instructions shown in the app to authenticate. You’ll be prompted to grant Webhooks Viewer read access to your apps.

After you authenticate, the instructions are replaced by the following content:

Step 2: Create a webhook subscription using the Heroku CLI

Next, you subscribe to webhook notifications using the Heroku CLI. Navigate to the Setup Instructions tab of Webhooks Viewer and follow its instructions.

Your webhook subscription will notify you whenever an app of your choice is deployed. You can choose one of your existing Heroku apps or create a new one.

Step 3: Test your subscription

To test that your webhook subscription works, initiate a release for the app you’ve subscribed to. (You can set a dummy config var value for the app to initiate a release for it easily.)

Shortly after you initiate the release, you should see the details of the notification arrive in Webhooks Viewer.

Advanced webhooks usage

Now that you’ve successfully subscribed to webhook notifications, see the full app webhooks documentation for more information on subscription options and supported event types.