Setting up webhooks

Make sure new content, and changes to existing content, are scanned automatically in Insytful as your editors update pages by setting up a webhook.

Webhooks are industry standard technology that are supported by many modern content management systems. This guide gives you the necessary information you need to set up a webhook in your CMS for Insytful.

Webhooks help keep your Insytful scan data up to date. This keeps reference content fresh for Insytful AI Search, so it can surface new and updated content as editors make changes.

If you need additional support with your CMS, please contact your administrator.

To keep Insytful and Insytful AI Search up to date with your content changes between scheduled scans, configure a webhook in your CMS. The webhook sends a request to Insytful when editors make changes to your content, such as publishing or updating a page.

Depending on your webhook configuration settings, it can trigger an update in Insytful when any of the following actions take place:

• Publish content
• Update content
• Unpublish content
• Delete content
• Archive content

When Insytful receives the request, it automatically scans the relevant page so that the content in Insytful stays up to date. This also helps keep Insytful AI Search up to date, so it can surface fresh content as editors make changes.

To set up a webhook with your CMS you need three pieces of information from Insytful. These can be found on your settings page:

1. Domain: the domain of your site. For example: https://www.contensis.com/
2. Site alias: the friendly alias of your site in Insytful. For example: contensis.com
3. API key: the API key for your site in Insytful found in site settings. This is used to validate that the requests are coming from your CMS. For example: ocJwNYBNZ19gsxYkURQ0MV0EsR18dtMY8dZQc510hY4FcQotpwRxVZApQw515Nkx4pNI0wZpIEw8YElA9xAQcsQFsx1x8Jk5RZoYVos9tgchMM0wF5MQk5dUdtAU04wd

Follow these instructions to set up a CMS webhook that automatically scans new or updated content in Insytful.

Please note: These are general webhook setup instructions. Labels and field names may depending on your CMS, but the process should be broadly similar.

1. Create a webhook in your CMS. Create a new webhook and give it a clear and descriptive name. For example: (Re)scan page in Insytful on publish.
2. Add the webhook URL. The webhook should send a POST request to the following URL: https://api.insytful.com/api/v1/webhooks/sites/ {{siteAlias}} /scan. Replace {{siteAlias}} with your site alias.
3. Configure when the webhook should trigger. Choose the events that should trigger the webhook. This will vary depending on your CMS and how you want the scan to work. For example, you may want the webhook to trigger whenever content is changed or published on the live site. You usually do not need to trigger the webhook for edits, deletes, approvals, or other events unless they result in a change to a live page.
4. Configure the payload. Configure the webhook to send the following payload part of the request:

The domain should be the fully qualified domain For example: https://www.contensis.com without a trailing /.

The pageURL will usually be a template variable from your CMS. The exact variable will depend on the CMS you are using. For example, it might look like this:

When triggered, this would send:

5. Configure the API key. Add your API key as a secret HTTP header. For example:
   x-api-key: your-api-key (replace your-api-key with your own API key)
6. Save, publish and test the webhook. Save and publish the webhook. Then publish a piece of content in your CMS to verify that the webhook is triggering correctly and is accepted by Insytful.