Webhook

In this guide we will walkthrough setting up Webhook configuration in monoZ:Link. We assume you have already have an external HTTP/HTTPS endpoint ready to receive data from monoZ:Link.

Webhook Configuration Setup:

1. Navigate to “Configuration” and click on “Add Configuration” from the top right corner.

2. Choose “Webhook” as destination protocol.

3. Add the destination server details and create the configurations.

   1. Specify MQTT in the Source protocol

   2. Enter your configuration name

   3. Enter suitable description for the configuration

   4. Enter the HTTP/HTTPS URL for the destination Server

   5. Select the Authorization method under the Parameters

   6. If you wish to give a custom header (e.g., group name, etc.) add your custom Header

   7. Choose Between ICCID or Topic to be sent along with the payload to the destination server

   8. Upon Submit the configuration shall be created

Webhook Data Push Format:

monoz:Link pushes data to the specified server in the following format.

Field	Item	Remarks
Method	Post
API URL	URL	Customer defined POST API URL
Header	Authentication	This will vary depending on the security method specified in monozLink. Security can be specified as Basic, BearerToken, or API Key
	Content Type	application/json
	content-length	Auto Calculation
	host	Auto provision
	Custom Header	User specified customer header
Body	ICCID	Device ICCID registered in monoZ:Link
		When a user specifies a topic in monZ:Link setting, the topic value is provided and the field name is changed from "ICCID" to "Topic".
	Timestamp	The timestamp when the data was sent from monoZ:Link (ISO:8601 format with milliseconds)
	Payload	Raw data sent by GW device, user needs to parse, extract and decode the required data

Webhook Data Push Rule:

1. When only a single data packet is received within one second from all devices associated with a monoZ:Link group, the platform sends one data push message containing that single data packet (See Example 1). When multiple data packets are received within one second from the devices in a monoZ:Link group, the platform sends multiple data push messages, each containing up to 10 data packets per message (See Example 2).
2. Upon data push to the user server, monoZ:Link will wait for a response for up to 90 seconds. In case of no ACK response from user server, monoZ:Link retry another 2 times before discarding the data push message.
3. If monoZ:Link receive error response from user server, it will not retry and shall immediately discard the data push message.

Example 1: When single packet is received in 1 second:

Field	Item
API URL	URL
Header	Authentication: Basic dGVzdDoxMjM0NTY3ODk=
	Content-Type: application/json; charset=utf-8
	content-length: 102
	host: xxxxyyyxxxyyyxxx.net
	1_Area: Tokyo
Body	{ "ICCID": 897612653856781234, "Timestamp": "2023-10-16T09:17:32.1233516Z", "Payload": "ABC" }

Example 2: When multiple packets are received in 1 second:

Field	Item
API URL	URL
Header	Authentication: Basic dGVzdDoxMjM0NTY3ODk=
	Content-Type: application/json; charset=utf-8
	content-length: 102
	host: xxxxyyyxxxyyyxxx.net
	1_Area: Tokyo
Body	[ { "ICCID": 897612653856781234, "Timestamp": "2023-10-16T09:17:32.1233516Z", "Payload": "ABC" }, { "ICCID": 897612653856787890, "Timestamp": "2023-10-16T09:17:32.8383516Z", "Payload": "123" } ]