Service hooks

Service hooks allow for easier integration of Sitefinity CMS with third party systems. With them you can run tasks on other services when an event happens in your Sitefinity CMS site. For instance, you can send a notification to an app when a news item has been published. 

With the appropriate license, you can create service hooks in the UI and add custom service hooks. To create service hooks, navigate to Administration » Service hooks. For more information, see Create service hooks

Service hooks utilize triggers and actions to subscribe to an event and then when the event is triggered to perform a pre-defined action.  

Trigger is an event or a set of events that will trigger the configured action.  

Actions define what happens when the trigger criteria are met. For instance, with the Webhook action, a post request is sent to the listening service.  Depending on your license you get access to the following Service hook actions:

  • Webhooks

  • Custom service hook actions

Webhooks are available for all licenses. With the webhook action, when a particular event is registered, the data for the event is sent to a URL that you have registered in the webhook.

The URL can be the URL of an external system or application that you want to integrate with Sitefinity CMS. The webhook action allows you to accomplish this without writing code in Sitefinity CMS.  

The Service hooks mechanism has its own module and configuration section in the Advanced settings. For more information, see Configure service hooks.

This section contains

Create service hooks
Learn how to create Service hooks in the UI.
Configure and migrate service hooks
Configure, migrate and create Service hooks in advanced settings.
Custom actions, triggers, and UI fields
Learn how to register custom triggers and actions and also how to implement custom UI fields.
List of service hook triggers and sample payload
List of service hook triggers and sample payload.
Service hooks history
Review service hook runs from the past 14 days and run again failed runs
Send custom payload
To change the default payload sent by service hooks, you need to create a custom action that modifies the payload before executing the service hook.
Create Sitefinity connectors using service hooks
Service hooks in Sitefinity provide a powerful and easy mechanism for creating custom connectors that can update external systems when an event occurs in Sitefinity
Want to learn more?
Enhance your Sitefinity skills by enrolling in free training sessions. Become Sitefinity certified through Progress Education Community to strengthen your professional credentials.
New to Sitefinity?