Skip to main content

​
Handle Webhook Event

This endpoint provides user information contained in the webhook event.

​
Request

Headers: Body: 
{
  "service": "user",
  "event": "user.data.download",
  "event_time": 1732793415,
  "timestamp": "2024-11-30T00:00:00Z",
  "client_id": "<client_id>",
  "data": {
    "status": 200,
    "url": "<https://eka.care/eka-user-verify-webpage-redirect-url>",
    "user_info": {
      "username": "<username>"
    }
  }
}

​
Field Descriptions

  • service: Specifies the service associated with the event.
  • event: The type of event being reported, such as user.data.download.
  • event_time: The Unix timestamp of when the event occurred.
  • timestamp: The timestamp of the event in ISO 8601 format (e.g., 2024-11-30T00:00:00Z).
  • client_id: Identifies the client receiving the event.
  • data: Contains additional details related to the event.
    • status: The HTTP status code of the event.
      • 200: User data is available, and a url is provided.
      • 404: User data not found, and url is omitted.
    • url: A link to access user-related information.
      • If the status is 200: The url field will contain a valid link.
      • If the status is 404: The url field will be omitted.
    • user_info: Contains details about the user involved in the event.
      • username: The username of the user.