Webhooks

Push events from source systems in real-time

What is a Webhook?

A webhook (also called a web callback or HTTP push API) is a way for any source system to push real-time events to FLOW. A webhook delivers as it happens, meaning you get data immediately. Unlike typical flows where you would need to poll for data very frequently in order to get it real-time. This makes webhooks much more efficient.

How to setup a Webhook in FLOW?

You would setup a Webhook like any other flow by choosing Input as Webhook. On the Input Settings page, paste a sample payload of the event to be captured using the webhook as shown below

1. Provide the date format that is used by the payload. Refer date-fns
2. Paste a sample payload to auto generate the schema based on the payload. You may want to provide an array with at-least two objects, one with no null values and the other with null as the value for all optional fields.

3. Click to generate the schema based on the sample payload provided

4. Review the schema visually in the schema editor and make any necessary adjustments

5. A read-only view of the generated schema

Webhook URL

Once you create a flow, you can then post events to the endpoint https://myflow.example.com/flow/push/<flow uuid>

e.g. https://flow.cloudio.io/flow/push/7e3paOczmNMp9Q8ZlXXei2

Webhook API

POST https://flow.cloudio.io/flow/push/:flow_uuid

Path Parameters

Name	Type	Description
flow_uuid	string	UUID of the Webhook flow

Headers

Name	Type	Description
Authorization	string	Basic XXX....
Content-Type	string	application/json;charset=utf-8

200 Successful response

{
  _status: "SUCCESS"
}

500 Error response

{
  _status: "ERROR",
  _message: "Error reason"
}