Trigger webhook test event

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.lumepay.com/mcp

Standard setup for AI tools providing an mcp.json file

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

POST /api/v1/webhooks/test-event

Queues a test.event delivery for active subscriptions owned by the authenticated API key owner. This event is a no-op health check and does not represent money movement.

Headers

X-API-KEY string Required

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

API secret paired with the public API key.

Responses

202 application/json

Test event accepted and matching outbox rows queued
Hide response attributes Show response attributes object
- eventType string
  
  Queued event type.
- resourceInternalTransactionId string
  
  Synthetic resource id for this test event.
- matchedSubscriptionCount integer(int32)
  
  Number of active subscriptions matched by the test event.
- queuedOutboxCount integer(int32)
  
  Number of outbox rows queued for delivery.
- outboxIds array
429 application/json

Cloudflare API rate limit exceeded
Hide response attributes Show response attributes object
- error string
- message string
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
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
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
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

POST /api/v1/webhooks/test-event

curl \
 --request POST 'https://api.staging.lumepay.com/api/v1/webhooks/test-event' \
 --header "X-API-KEY: string" \
 --header "X-API-SECRET: string"

Response examples (202)

{
  "eventType": "test.event",
  "resourceInternalTransactionId": "test_96e3d0fb6f7445098ec197bb4350e993",
  "matchedSubscriptionCount": 1,
  "queuedOutboxCount": 1,
  "outboxIds": [
    "evt_8410b4d047d44572b09f2e828c3ccb5a"
  ]
}

Response examples (429)

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

Response examples (403)

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

Response examples (500)

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

Response examples (400)

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

Response examples (401)

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