Webhook

Last updated on Dec 28, 2022

We have migrated our webhooks infrastructure for better scalability and throughput. As a result, the old Webhook URLs are deprecated and will stop working soon. Please migrate to the new webhook URL (provided in the Set up Webhook section of your Pipeline Overview page) to avoid disruption in your data loading operations.

new webhook notice

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 especially useful if new data is being actively generated in your Source. Instead of Hevo checking for updates at specific intervals, you can configure the URL that your Webhook Pipeline and directly send the data to Hevo as soon as it is generated.

Configure your Webhook Source

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

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE 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:

    Source Config Image

    • 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:

      • Authentication Method: The method by which your Source authenticates Hevo. Default: No Authentication. Select one of the following:

        • No Authentication: Push events from your Source to Hevo without any authentication. To use this option, click CONTINUE and proceed to create a Destination.

          No-Authentication

          Hevo provides you with a Webhook URL. Use this URL in the application from which you want to push data to Hevo.

          Webhook_URL

      • Basic Authentication: Push events from your Source to Hevo securely using an API key to authenticate Hevo.

        1. Click + NEW API KEY to create an access key and a secret key.

          Basic_auth

        2. In the API KEY pop-up dialog, click the Copy icon corresponding to the Access Key and Secret Key to copy and save them like any other password.
          Note: You can also click DOWNLOAD to download these in a JSON file.

          Download_access_key_secret_key

        3. Click CONTINUE.

          Click_continue

        4. Hevo provides you with a Webhook URL. Specify this URL, the access key and the secret key you saved, in the application from which you want to push data to Hevo.

          Copy-URL-&-Access-key

  5. Proceed to configuring your Destination.

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Dec-19-2022 2.04 Added information about support for the Basic Authentication method to securely send data to Hevo.

Tell us what went wrong