This project adds webhook capabilities to Episerver sites, allowing events relating to IContent stored in Episerver to be handled by external systems.
After installing the nuget package, a new CMS navigation item is added which takes users to the Webhooks UI. The UI allows for webhooks to be created, tested, updated and deleted as well as allowing for an at-a-glance view of the last result for each webhook.
Out of the box, the add on supports 5 content events:
- Publish - Called once a page has been published
- Moving - Called before a page has been moved
- Move - Called after a page has been moved
- Recycled - Called after a page has been moved to the recycle bin
- Deleted - Called before a page has been deleted
Content save events have been intentionally ignored as they occur almost constantly while editing a page however it is possible to register your own events if this is required.
When one of the supported events is triggered by a content event, any webhooks targetted to that event, content location and content type will be retrieved and a POST request will be made to the defined URL. The body of the post request contains information about the event fired, the content that triggered it and any other content items impacted by the event. The JSON serialiser from the content delivery API is used to serialise the content and so the structure of the serialised content data should match data retrieved from the content delivery API, including customisations such as flattening the structure.
When creating a webhook, tokens can be used within the URL and custom header fields to allow information such as keys or environment-specific values to be pulled in. Tokens are in the format ${TokenName} where TokenName is a key registered using the RegisterPlaceholder(string token, string value) method of the IWebhookRepository. The value associated with the token will replace the token placeholder. In the event that the token name doesn't match a key, the token placeholder will be left as-is. Registering tokens and their values will typically be done in an IInitializableModule though, if you want to register all appsettings values from your web.config file, you can add the following app setting to your config:
<add key="WH:AutoRegisterAppSettings" value="true" />
N.B. Before using this config value, ensure you are aware of the implications. By registering all appsettings like this, it is possible to extract potentially sensitive data from configuration and send it to an arbitrary URL.
The solution includes the add-on itself plus an alloy site to which changes will be deployed on build, allowing for simpler debugging without the need to build and install the package.
The project is released under an MIT license and, as such, is provided as-is, without warranty of any kind, express or implied. For full details see the license file.