Dataflow Automation Webhooks

What's covered:

• What is a Webhook?
• What is a Secure Webhook?
• How does the Secure Webhook work?
• How do I create a Secure Webhook? 

Also, be sure to check out:

• Digital Signature on Data Delivery

What is a Webhook?

A webhook delivers data to other applications as it happens, meaning you get data immediately.

In terms of Dataflow Automation, the webhook serves the role of allowing a web service to automatically send information to your Dataflow. Every DFA webhook has a unique identifier called a "Webhook URL".

This is used by other applications as a data destination, similar to an email address for a message. 

What is a Secure Webhook?

The Secure Webhook option is for those who require additional security. Only data coming in from the verified source would get processed by the Dataflow, therefore, protecting unwanted data from entering the system. Currently, anyone who has access to the Webhook URL would be able to post data to the Dataflow. 

How does the Secure Webhook work?

When you create the Secure Webhook, Dataflow Automation will generate a pair of Public/Private keys. The Public Key will be stored in the database while the Private Key is given to the user. The user will then generate a unique key, this unique key will be used to “sign” the data payload. The Private Key is then used to encrypt the unique key. 

How do I create a Secure Webhook?

To create a Secure Webhook, please follow the instructions below.  

PLEASE NOTE: In this example, we'll be securing a previously created Webhook. This can also be implemented when creating a Webhook from scratch.

Click here for more information on creating a Webhook.

STEP 1. From the Dataflow Automation interface, click the Dataflow you will be adding the Secure Webhook to. 

STEP 2. Select the Webhook you wish to make secure.

STEP 3. From the Data Sources drop-down, select Edit Webhook.

STEP 4. Click Secure and hit Save.

STEP 5. Download the Private Key and select Close.

STEP 6. Copy the Webhook URL.

STEP 7. From inside your iFormBuilder account, paste the copied Webhook URL into the Endpoint URL field.

Click here for instructions on setting Post Data within iFormBuilder.

STEP 8. From the Mode drop-down menu, leave Insert/Update or change to Delete depending on your preference.

STEP 9. From the Secure Signature drop-down, select RS256.

STEP 10. Click Choose File and upload the Private Key you downloaded in Step 5.

STEP 11. Click Create Endpoint.

STEP 12. Create some sample records and submit them to make sure they process correctly.