Events
Discovery service to identify valid triggers. Use the name field returned here for your subscription configuration.
GET /api/v1/events
Summary: Returns the complete list of events available for subscription.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name |
string |
No | Partial search (contains) to filter events by name. |
Response Data (EventResponse)
| Field | Type | Description |
|---|---|---|
id |
integer |
Unique numerical identifier of the event. |
name |
string |
The technical string key (e.g., loan.disbursement.success). |
description |
string |
Human-readable trigger explanation. |
Success Response (200 OK):
{
"data": [
{
"id": 42,
"name": "loan.approved",
"description": "Triggered when a loan application is successfully approved."
}
]
}