Overview: Configuring Custom Deployment using Webhooks

For customers who want to deploy schema markup server-side on websites where Schema App does not have an integration, we created the ability for your Development Team to set up Webhooks integration with Schema App. In general we recommend using one of our established deployment methods, but this option does exist for the customers that require it.

Note: While we can provide email support, we cannot provide in-depth technical support when using Webhooks for custom deployment (e.g non-WordPress) websites. This method is only recommended for teams with the required technical expertise.

TABLE OF CONTENTS

• Overview
• Troubleshooting Failed Webhooks
  • 1. Cause: Security Policies
    • Solution: Ensuring Webhooks are not Blocked
  • 2. Cause: Misconfigured Webhook
    • Solution: Schema App Investigates

Overview

Webhooks notify applications when specific events occur in your Schema markup. Examples of each are below

• EntityCreated when markup for a page is first created
• EntityUpdated when markup for a page is updated
• EntityDeleted when markup for a page is deleted

To deploy via Webhook you must first add an endpoint from Integrations > Webhooks > + Add Endpoint. Data will be sent to this endpoint based on changes in your markup, for example:

• You update an item in the Editor
• A crawler (if configured) runs and generates markup
• Highlight JavaScript (if configured) runs and generates markup
• Merchant Center runs and generates markup

The payload sent to your server contains information about where it originates from, and where you can new markup for that page by calling the API. For convenience the markup is included in the "graph" object which can be used directly. 

The Webhooks page in integrations also provides the response we received from your server. You can resend Webhooks as well to test your integration as you make changes. 

You can expand the row to see the full details of the request and response

Troubleshooting Failed Webhooks

If Webhooks are failing there are two possible causes which each have their own solution.

1. Cause: Security Policies

Security policies in WordPress or on your hosting server are preventing Schema App's requests from being sent to your Webhooks. This will appear as 405 status codes in the log history.

Solution: Ensuring Webhooks are not Blocked

Webhooks are sent via POST requests to your server. The Webhooks will originate from the following IP: 52.45.62.191. It will send the request to the Endpoint URL (shown in above image). 

If you are using WordPress, the URL will be based on the domain of your site with an endpoint path i.e if your site is https://www.example.org then the endpoint will be  https://www.example.org/wp-json/hunch_schema/cache/path This endpoint is autoconfigured when you install the WordPress plugin but is visible on the Webhooks page. 

We recommend whitelisting the 52.45.62.191 IP for the Webhook endpoint to ensure your server can receive Webhooks from Schema App.

2. Cause: Misconfigured Webhook

There is something misconfigured with the Webhook. This will appear as a different status code.

Solution: Schema App Investigates

Open a ticket and Schema App's development team will review the Webhook configuration in order to diagnose the issue.

For more information please contact [email protected].