Skip to main content
GET
/
v1
/
webhooks
/
events
List Events
curl --request GET \
  --url https://api.example.com/v1/webhooks/events \
  --header 'Authorization: <authorization>'
{
  "total": 100,
  "events": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "eventId": "660e8400-e29b-41d4-a716-446655440001",
      "tenant": "partner-name",
      "eventType": "kyc.status.changed",
      "payload": {
        "userId": "user-123",
        "status": "approved"
      },
      "userId": "user-123",
      "sourceService": "kyc-service",
      "status": "completed",
      "createdAt": "2025-12-29T10:00:00.000Z",
      "processedAt": "2025-12-29T10:00:05.000Z",
      "queuedAt": "2025-12-29T10:00:01.000Z"
    }
  ]
}

​
List Events

GET https://api.baanx.com/v1/webhooks/events Retrieves a list of events for the authenticated partner.

​
Overview

Events are notifications generated by the system that have been or will be delivered to your configured webhooks. Use this endpoint to monitor event processing status, identify failed events, and review recent activity.

​
Authentication

This endpoint requires authentication via Bearer token: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
Request

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Query Parameters

​
status
string
Filter events by processing status.Accepted values: pending, processing, completed, failed, skipped
​
limit
integer
default:50
Maximum number of events to return. Range: 1–100.

​
Request Example

curl -X GET "https://api.baanx.com/v1/webhooks/events?status=failed&limit=25" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Response

​
200 Success

​
total
integer
Total number of events matching the query
​
events
array
Array of event objects
​
events[].id
string (UUID)
Unique identifier for this event record
​
events[].eventId
string (UUID)
Business event identifier
​
events[].tenant
string
Partner tenant identifier
​
events[].eventType
string
Type of event (e.g., kyc.status.changed, card.activated, transaction.cleared)
​
events[].payload
object
Event payload data
​
events[].userId
string | null
Associated user ID, if applicable
​
events[].sourceService
string
Name of the service that generated this event
​
events[].status
string
Current processing status: pending, processing, completed, failed, or skipped
​
events[].createdAt
string (ISO 8601)
Timestamp when the event was created
​
events[].processedAt
string (ISO 8601) | null
Timestamp when the event was processed (null if not yet processed)
​
events[].queuedAt
string (ISO 8601) | null
Timestamp when the event was queued for delivery
{
  "total": 100,
  "events": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "eventId": "660e8400-e29b-41d4-a716-446655440001",
      "tenant": "partner-name",
      "eventType": "kyc.status.changed",
      "payload": {
        "userId": "user-123",
        "status": "approved"
      },
      "userId": "user-123",
      "sourceService": "kyc-service",
      "status": "completed",
      "createdAt": "2025-12-29T10:00:00.000Z",
      "processedAt": "2025-12-29T10:00:05.000Z",
      "queuedAt": "2025-12-29T10:00:01.000Z"
    }
  ]
}

​
Error Responses

{
  "message": "Not authenticated"
}
  • GET /v1/webhooks/events/{eventId}/status - Get status of a specific event
  • GET /v1/webhooks/events/{eventId}/logs - View delivery logs for a specific event
  • POST /v1/webhooks/events/{eventId}/retry - Retry delivery of a failed event