Topics

All topics

Headless API

Webhook

This article contains
NEW TO SITEFINITY?

Overview

The Webhook allows you to subscribe to different Sitefinity CMS events. When a particular event is registered by the EventHub system, the data for the event is sent to a particular 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 allows you to accomplish this without writing code in Sitefinity CMS.

Implementation

The Webhook mechanism has its own module and configuration section in the Advanced settings. The Webhook module is disabled by default. 

In the configuration section, you can configure a collection of event types. For these types you register one or more URLs. 
These are events that are raised by the Sitefinity CMS EventHub and can only be public interfaces that inherit from IEvent, for example -Telerik.Sitefinity.Web.Events.ILoginCompletedEvent. 

For each event, you can have a collection of URLs. To these URLs, the Webhook sends a POST request with Content-Type: application/json. The body of the request contains the event properties serialized in JSON format.

Supported events

The Webhook module supports the following events:

  • Telerik.Sitefinity.Web.OutputCache.IOutputCacheInvalidationEvent
  • Telerik.Sitefinity.Web.Events.ILoginCompletedEvent
  • Telerik.Sitefinity.Modules.Forms.Events.IFormEntryCreatedEvent

Setup procedure

PREREQUISITES: To use the Webhook, you must activate the Webhook module from Administration » Modules & Services.

To setup the Webhook, perform the following:

  1. In Sitefinity CMS backend, navigate to Administration » Settings » Advanced.
  2. In the treeview on the left, expand Webhook and click Webhook events » Create new.
  3. Enter the Event type that you want to register.
    You can enter one of the supported events.
  4. Save your changes.
  5. To register a URL where the event will send its data, expand the already registered event and click URLs » Create new.
  6. In URL, enter the URL where you want to send the event’s data.
  7. Add a layer of security using the Secret field.
    Enter a secret that is strong enough.
    Sitefinity CMS uses this secret to compute a Hash-based message authentication code (HMAC) of a string in this format: {body_of_request}_{timestamp}.  This is converted to Base64 string. The timestamp is the current Unix timestamp in milliseconds. The hashing algorithm used is SHA256. Sitefinity CMS sends the HMAC as a Sf-Signature header and the timestamp as a Sf-Signature-Timestamp header. 

    IMPORTANT: If you configure a secret, then you must compute the hash on the other side, using the secret and the timestamp, and compare it with the Sf-Signature header. This way you can ensure that the request comes from Sitefinity CMS and can prevent others from sending invalid data to the endpoint. 

  8. Save your changes.

Webhook sample JSONs

IOutputCacheInvalidationEvent

{
"ExpiredItems": [
{
"Key": "gb19cxq8M-g6d4_rq8zLghDB5OiTPJtJMzAuZWgmE6w1",
"SiteId": "6405b415-34aa-43cf-b947-768867944880",
"ETag": null,
"Url": "/testPageUrl",
"Host": "https://www.example.com"
}
],
"Origin": null
}
view raw IOutputCacheInvalidationEvent.json hosted with ❤ by GitHub

ILoginCompletedEvent

{
"LoginResult": 9,
"UserId": "2be8256a-43bf-4755-aaaf-ae0fe303000f",
"Username": "test username",
"ProviderName": "Default",
"IpAddress": "::1",
"IsBackendUser": true,
"Email": "test@test.test",
"Origin": "Sitefinity Login - RP"
}
view raw ILoginCompletedEvent.json hosted with ❤ by GitHub

IFormEntryCreatedEvent

{
"EntryId": "7395bdb5-6cda-4694-96da-313fdbf4f4f9",
"ReferralCode": "2",
"UserId": "2be8256a-43bf-4755-aaaf-ae0fe303000f",
"Username": "admin@test.test",
"IpAddress": "::1",
"SubmissionTime": "2019-08-28T10:59:29.1939411Z",
"FormId": "8066a07e-77a8-4098-8769-be95ef2e20a0",
"FormName": "sf_sampleformmvc",
"FormTitle": "Sample Form MVC",
"FormSubscriptionListId": "00000000-0000-0000-0000-000000000000",
"SendConfirmationEmail": false,
"Controls": [
{
"FieldControlName": null,
"Id": "04b55fb4-eb69-4a3e-8e30-048d6b406af4",
"SiblingId": "c2599e0c-e489-4e39-bde1-215f716a4538",
"Text": null,
"Type": 0,
"Title": "Sample Textbox Field",
"FieldName": "TextFieldController",
"Value": "Sample Textbox Fi",
"OldValue": null
},
{
"FieldControlName": null,
"Id": "5f9fd2dd-3ace-4e62-aa57-2325659147ca",
"SiblingId": "04b55fb4-eb69-4a3e-8e30-048d6b406af4",
"Text": null,
"Type": 0,
"Title": "Email",
"FieldName": "EmailTextFieldController",
"Value": "mail@test.test",
"OldValue": null
},
{
"FieldControlName": null,
"Id": "a7c80168-4eb9-4abf-b486-c0cff0235803",
"SiblingId": "5f9fd2dd-3ace-4e62-aa57-2325659147ca",
"Text": null,
"Type": 0,
"Title": "Sample Paragraph Field",
"FieldName": "ParagraphTextFieldController",
"Value": "ple Paragraph Field",
"OldValue": null
},
{
"FieldControlName": null,
"Id": "655555ff-43e3-496d-9db8-899561ff8a9a",
"SiblingId": "a7c80168-4eb9-4abf-b486-c0cff0235803",
"Text": null,
"Type": 0,
"Title": "Dropdown",
"FieldName": "DropdownListFieldController",
"Value": "First Choice",
"OldValue": null
},
{
"FieldControlName": null,
"Id": "b55deb7f-c423-460a-871c-0aac741ce0f6",
"SiblingId": "655555ff-43e3-496d-9db8-899561ff8a9a",
"Text": null,
"Type": 3,
"Title": "Content block text<br />",
"FieldName": null,
"Value": null,
"OldValue": null
},
{
"FieldControlName": null,
"Id": "5d54b01e-9551-404f-aaef-2b8d1eb3ce59",
"SiblingId": "b55deb7f-c423-460a-871c-0aac741ce0f6",
"Text": null,
"Type": 0,
"Title": "Checkboxes",
"FieldName": "CheckboxesFieldController",
"Value": "First Choice,Second Choice",
"OldValue": null
},
{
"FieldControlName": null,
"Id": "b866863f-c11e-4e79-963b-3162825918de",
"SiblingId": "5d54b01e-9551-404f-aaef-2b8d1eb3ce59",
"Text": null,
"Type": 1,
"Title": "File Upload Label",
"FieldName": "FileFieldController",
"Value": null,
"OldValue": null
},
{
"FieldControlName": null,
"Id": "5b31a5a7-acb6-4d4b-b494-3341977cd2ee",
"SiblingId": "b866863f-c11e-4e79-963b-3162825918de",
"Text": null,
"Type": 0,
"Title": "Multiple Choice",
"FieldName": "MultipleChoiceFieldController",
"Value": null,
"OldValue": null
},
{
"FieldControlName": null,
"Id": "0d751c9e-da99-4d6d-8d25-6b748cf0e849",
"SiblingId": "078aa17e-4b45-4aba-9ba8-56ff9e7218f1",
"Text": null,
"Type": 0,
"Title": null,
"FieldName": "HiddenFieldName",
"Value": "",
"OldValue": null
}
],
"NotificationEmails": null,
"Origin": null
}
view raw IFormEntryCreatedEvent.json hosted with ❤ by GitHub

Want to learn more?

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?

Next article

Custom services