Skip to main content

Webhooks Overview

In We-Link, most API interactions — such as sending connection requests, logging in, or syncing messages — are asynchronous. When you make an API call, you receive an immediate acknowledgment containing a requestId rather than the final result. The actual processing happens in the background.

Webhooks are the mechanism we use to deliver the final results of these background tasks to you in real-time. Instead of constantly polling our API, We-Link pushes data to a URL you configure the moment an event occurs.

How the Webhook Flow Works​

  1. Initiate Action — You make an API call (e.g., /api/v1/connect). We return a requestID immediately.
  2. Background Processing — Our engine executes the task safely, managing delays and LinkedIn's rate limits.
  3. Notification — Once the task is complete, we send a POST request to your configured webhook URL with the result.

Payload Structure​

Every webhook payload follows a consistent structure:

Success Payload​

{
  "status": "SUCCESS",
  "requestId": "1234ab5678290....",
  "result": {  // result may vary according to the type of the endpoint
    "connected": true,
    "profile_id": "ACoABC1d2f..."
  },
  "hash": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...."  // hash for verification
}

Failure Payload​

{
  "status": "PROFILE_NOT_FOUND",
  "request_id": "1234ab5678290....",
  "message": "Profile not found",
  "hash": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...."
}