Webhook & Websocket Integration

Power your integrations with real-time data processing using webhook and websocket. Whether you’re receiving events from external systems or delivering them instantly to clients, webhook and websocket support reliable real-time communication.

What are Webhooks and Websockets?

• Webhook: A webhook is a user-defined HTTP callback. It is triggered by an event in a source system and sends real-time data to a specified URL via an HTTP POST request. Webhooks are one-way communication, ideal for pushing data when an event happens.

• Websocket: A websocket is a full-duplex communication protocol that allows continuous, real-time data transfer between the client and server. Once connected, data can be pushed to the client instantly without repeated polling.

Webhook

Webhook enables external applications to push real-time data to your system, allowing for instant event handling and integration.

To test the webhook URL in eZintegrations, enter the following in your request setup:

Webhook Endpoint

Method: POST

Authentication Methods Supported:

You can pass client_id and client_secret using any one of the following methods:

• Basic Authorization header

   

  Authorization: Basic {{Base64Encoded(client_id:client_secret)}}
• As Basic Auth credentials
  
  Set client_id as the username and client_secret as the password

• Passed directly in the URL

  https://{{BaseUrl}}/api/webhook?client_id={{client_id}}&client_secret={{client-secret}}

Note: You can retrieve your client_id and client-secret from API Settings under the My Profile page, accessible via the settings gear icon in the top-right corner of the eZintegrations platform.

You can pass the client-secret either in the request headers or as a query parameter (client_secret) along with the client_id. The API will return the correct response in both cases.

Payload Format:

Here’s an example payload that can be posted to the webhook

{

  "userName": "mark_wilson",

  "userEmail": "mark@example.com",

  "subscriptionPlan": "Premium",

  "accountStatus": "Active",

  "signupDate": "2025-04-16",

  "lastLogin": "2025-04-15"

}

Note: Payload should be sent in JSON format.

Websocket

Websocket enables real-time communication by allowing clients to receive live data updates instantly, without the need for repeated requests

Websocket Endpoint

To test the websocket URL in eZintegrations, enter the following in your request setup:

URL:

wss://{{BaseUrl}}/api/ws?client_id={{client_id}}

Header:

client-secret = {{client-secret}}

Message:

{

  "eventType": "broadcast_notification",

  "message": "System maintenance is scheduled at 01:00 AM UTC",

  "priority": "high",

  "timestamp": "2025-04-16T13:00:00Z"

}

Note: Message should be sent in JSON format.

Note: You can retrieve your client_id and client-secret from API Settings under the My Profile page, accessible via the settings gear icon in the top-right corner of the eZintegrations platform.

Important :
To send data from the webhook to the websocket client, use the same client_id and client-secret in both the webhook and websocket URLs. This ensures that the system correctly authenticates and routes data in real time to the appropriate websocket connection.

Authentication Instructions:

To acquire the Base URL and create your own Client ID and Secret, please refer to the My Profile section within your Bizdata account.