List webhook events | Lumetrade Staging API documentation

List webhook events Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://docs.staging.lumetrade.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Lumetrade Staging API MCP server": {
    "url": "https://docs.staging.lumetrade.com/mcp"
  }
}

GET /api/v1/webhooks/events

Returns the active v1 webhook event catalog. Subscribe with the customer-facing eventType value, for example deposit.completed.

Headers

X-API-KEY string Required

Public API key issued from the Lumetrade API key management flow.
X-API-SECRET string Required

API secret paired with the public API key.

Responses

200 application/json

Webhook events returned successfully
Hide response attributes Show response attributes object
- eventType string
  
  Customer-facing event key used in subscription requests.
- resourceType string
  
  Resource category for the event.
- event string
  
  Event name within the resource category.
- displayName string
  
  Human-readable event name.
- description string
  
  Short description of when the event is emitted.
403 application/json

Authenticated API key is not allowed to perform this action
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
429 application/json

Cloudflare API rate limit exceeded
Hide response attributes Show response attributes object
- error string
- message string
401 application/json

API key authentication failed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
400 application/json

Request validation failed
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string
500 application/json

Unexpected server error
Hide response attributes Show response attributes object
- code integer(int32)
- message string
- httpStatus integer(int32)
- requestId string
- timestamp string(date-time)
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  field string
  
  message string

GET /api/v1/webhooks/events

curl \
 --request GET 'https://api.staging.lumetrade.com/api/v1/webhooks/events' \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string"

Response examples (200)

[
  {
    "eventType": "deposit.completed",
    "resourceType": "deposit",
    "event": "completed",
    "displayName": "Deposit completed",
    "description": "Deposit has completed."
  }
]

Response examples (403)

{
  "httpStatus": 403,
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 403,
  "message": "Authenticated API key is not allowed to perform this action",
  "requestId": "req_01HY0000000000000000000000"
}

Response examples (429)

{
  "error": "rate_limit_exceeded",
  "message": "API rate limit exceeded"
}

Response examples (401)

{
  "httpStatus": 401,
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 401,
  "message": "API key authentication failed",
  "requestId": "req_01HY0000000000000000000000"
}

Response examples (400)

{
  "httpStatus": 400,
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 400,
  "message": "Request validation failed",
  "requestId": "req_01HY0000000000000000000000"
}

Response examples (500)

{
  "httpStatus": 500,
  "errors": [],
  "timestamp": "2026-01-01T00:00:00Z",
  "code": 500,
  "message": "Unexpected server error",
  "requestId": "req_01HY0000000000000000000000"
}