Articles in this section

See more

Using Webhooks

Avatar
Andy
  • Updated

Last updated
20210406
Article type
Step-by-step
Applies to
Starter, Business, Pro-Marketer
Special contents
n/a

Details

Webhooks are one of several ways that web applications can use to communicate with each other. They allow you to send real-time data from one application to another, whenever a specific event occurs.

They differ from APIs in that webhooks are triggered by our platform - instead of APIs, which are triggered from your platform.

 

An Example

To provide a simplified example, let's take a look at the same scenario under an API and a webhook setup.

Scenario: A cake is baking in the oven (Vision6) & the human (your custom application) wants to know when it's ready so they can remove it from the oven.

  • Webhook: In this scenario, the oven (Vision6) would tell the human (your custom application) when the cake is ready. Then the human can remove it. No time or resources wasted, and our platform does the work.
  • API: In this scenario, you would check the oven (Vision6) every few minutes to see if the cake is done. In checking every few minutes, you waste time and resources. And what if you don't check often enough? The cake might start to overcook and dry out!

 

Developer Documentation

We welcome you to share our detailed Webhook Documentation with your developer.

 

How-to Guide

In this guide, we'll walk you through how to create keys so that you can provide them to your developer. 

Webhook keys should only be shared with trusted parties. Do not create & share webhook keys online, or in response to an unsolicited request from an unrecognised person.

  1. Log into your account and go to the Account area (⚙️ icon, at top right).
  2. Select Webhooks from the menu.
  3. Click New Webhook.
  4. Give the webhook a name (eg. 'Transactional Webhook')
  5. Enter the webhook URL. This is the location that we should send data to (ask your developer for details on what to enter here if unsure).
  6. Enter a description.
  7. Select the events you want the webhooks to notify on.
  8. Click Create Webhook.

The page will reload and your two webhook keys will be displayed (two keys are provided for rotational security purposes). You can now share these keys and our documentation (linked in the section above) with your developer.

 

Article is closed for comments.