What are webhooks ?

Webhooks are automated HTTP messages that are sent from one website to another. They are typically used to notify when a particular event has occurred or to send updated data. Unlike APIs, webhooks do not require a request to be sent before sending a response; they will simply send the data to your URL when it becomes available. You can read more about webhooks here.


What does a Webhook Connector do ?

The Webhook Connector function enables you to configure and test webhook URLs so that you can collect JSON data from external systems in real time. Peak platform depends on several business systems to send data in real-time in order to provide predictive insights.


Why should I use it?

Webhooks are most suitable for push based data feeds, we recommend the use of Webhook connections when you don't want to constantly call a system to check for new data.


Contents

Getting to the screens

    1. Go to Dock > Data Sources.
        The Feeds screen appears.


   

2. Click ADD.
    The Choose Connector screen appears.



3 .Under Applications Connectors section, click Webhook.
    The Create Feed screen appears.



Creating a webhook feed

Complete the following steps to create a Webhook feed - 

  • Enter a suitable name for the feed. For naming feed follow the below convention
    • Only alphanumeric and underscore characters are allowed
    • It must start with a letter
    • Must not end with an underscore
    • Up to 50 characters allowed
  • Click SAVE AND GENERATE URL.
    You will be returned to the Feeds screen where the new Webhook feed is listed.


Destination

  • Data is loaded in incrementally.
  • This data is processed as an external table during the ingestion process, ready for you to query it in SQL Explorer. For more information on using SQL Explorer.


Managing webhook feeds

Once you have created a webhook feed, it is listed on the Feeds screen.

From here you can:

  • Run, Test, Tag or Delete the feed.
    Hover your pointer over the feed to access the controls.
  • View logs for the feed
  • View information about the feed, such as its webhook URL.



Getting the Webhook URL for a feed

  1. From the Feeds screen, click the required webhook feed.
    Details for the feed appear.
    The default view is the feed logs tab. See below for details of this screen
  2. Click the Info tab.
    This shows details of when the feed was created and the URL of the webhook.
  3. Copy the URL to use it.



Testing a Webhook feed

On the data source page for a webhook you can choose test option by hovering on the feed.
You can test the feed using a JSON payload



Viewing webhook feed logs

The Logs tab shows the feed activity.