Webhook

You can use Webhook to push data from your Source to Hevo in real-time. The Hevo Pipeline then replicates this data to your Destination database or data warehouse.

A Webhook-based Pipeline is useful when new data is actively generated in your Source. Instead of Hevo checking for updates at specific intervals, you can configure the URL provided by your Webhook Pipeline in the application and directly send the data to Hevo as soon as it is generated. You can also configure your Webhook Pipeline using the Hevo API and send one or more files up to 16 MB each in an API call.

---

Prerequisites

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo, to create the Pipeline.

---

Configure your Webhook Source

Perform the following steps to configure Webhook as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. In the Select Source Type page, select Webhook.

4. In the Configure your Webhook Source page, specify the following:

   

   • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

   • Event Name Path: The path to the field from which data should be retrieved. For example, eventName.

   • Fields Path: The path to the field from where you want to retrieve data from. For example, properties.

     For example, in the sample event below the Event Name Path is eventName and Fields Path is properties:

     
     curl --location --request POST 'https://asia-webhook.hevo.io/t/qnxaukssoq' \
     --header 'Content-Type: application/json' \
     --data-raw '{
       "eventName": "payment.authorized",
       "properties": {
             "id": "pay_DESlfW9H8K9uqM",
             "entity": "payment",
             "amount": 100,
             "currency": "INR",
             "status": "authorized",
             "order_id": "order_DESlLckIVRkHWj"
     
       }
     }'
     

   • Advanced Settings:

     • Basic Authentication: The method by which your Source authenticates Hevo.

       • If disabled, the Events are pushed from your Source to Hevo without any authentication. After creating the Pipeline, Hevo provides you with a Webhook URL. Use this URL in the application from which you want to push data to Hevo. To use this option, click CONTINUE and proceed to configuring your Destination.

         

       • If enabled, the Events are securely pushed from your Source to Hevo using an API key. To create the API key, perform the following steps:

         1. Click + NEW API KEY.

            

         2. In the API KEY pop-up window that appears, click the Copy icon corresponding to the Access Key and Secret Key to copy and save them securely like any other password. Alternatively, you can click DOWNLOAD to download the keys in a JSON file.

            

         3. Click CONTINUE to proceed to configuring your Destination.

            

         4. After creating the Pipeline, Hevo provides you with a Webhook URL and Access Key. Specify the URL, access key, and secret key that you saved in the application from which you want to push data to Hevo.

            

---

Source Considerations

• Webhook only supports JSON files up to 16 MB in size.

---

See Also

• Creating a Webhook Pipeline

• Data Loss Prevention and Recovery

• HTTP Basic Authentication

---

Revision History