Skip to main content

​
Overview

Webhooks allows Ghost to send POST requests to user-configured URLs in order to send them a notification about it. The request body is a JSON object containing data about the triggered event, and the end result could be something as simple as a Slack notification or as complex as a total redeployment of a site.

​
Setting up a webhook

Configuring webhooks can be done through the Ghost Admin user interface under Settings > Advanced > Integrations > Add custom integration. The only required fields to setup a new webhook are a trigger event and target URL to notify. This target URL is your application URL, the endpoint where the POST request will be sent. Of course, this URL must be reachable from the Internet. If the server responds with 2xx HTTP response, the delivery is considered successful. Anything else is considered a failure of some kind, and anything returned in the body of the response will be discarded.

​
Available events

Currently Ghost has support for below events on which webhook can be setup:

​
Stripe webhooks

Webhooks allow Ghost to communicate with Stripe. In order to use Stripe with a local version of Ghost you’ll need to do some additional setup to allow webhook events happen between Stripe and Ghost. First, follow the instructions on how to install and log into the Stripe CLI tool in the Stripe documentation. Then, before starting a local instance of Ghost, run the following command in your CLI. Note that the localhost port number should match the one used in your local Ghost install:
After running this the CLI will return a secret prefixed with whsec_. This secret needs to be given to Ghost on start up. In a new CLI window run the following:
After following these steps, Ghost will run locally with a webhook connection to your Stripe account. To test that it’s working, sign up for a paid membership on the local site. Now that the local install of Ghost is running and communicating with Stripe, you can develop and test themes for a custom membership experience, build signup and signin forms, or expose member data.