Skip to main content

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

URL:

https://{{BaseUrl}}/api/webhook?client_id={{client_id}}

Header:

client-secret = {{client-secret}}

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

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.

Once this data is sent to the webhook, it will immediately be received by the websocket client.

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",
  "fromClientId": "admin_client",
  "message": "System maintenance is scheduled at 01:00 AM UTC",
  "priority": "high",
  "timestamp": "2025-04-16T13:00:00Z"
}

Note: Payload should be sent in JSON format.

Once connected, any data sent to the webhook will be instantly pushed to this websocket connection.

Note: You can retrieve your client_id and client-secret from yourAPI Settings under the My Profile page, accessible via the settings gear icon in the top-right corner of the eZintegrations profile.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.

For BaseUrl, and any support related to client_id, or client-secret required for webhook and websocket configuration, please reach out to our support team:

Email:  mailto:support@bizdata360.com



Back to top