events.list
Retrieve a list of Ryft events to monitor payment sessions, customers, subscriptions, payouts, and disputes. Filter by account and control sorting and limits.
Instructions
List Ryft events.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ascending | No | ||
| limit | No | ||
| accountId | No |
Implementation Reference
- src/tools/events.ts:18-30 (registration)The registration of the 'events.list' tool, which includes the handler implementation inline.
registerTool( 'events.list', 'List Ryft events.', listEventsSchema.shape, async (args) => { const parsed = listEventsSchema.parse(args); const { accountId, ...query } = parsed; return client.get('/events', { query: query as Record<string, QueryValue>, ...(accountId ? { accountId } : {}), }); }, ); - src/tools/events.ts:6-10 (schema)The Zod schema definition for the arguments accepted by 'events.list'.
const listEventsSchema = z.object({ ascending: z.boolean().optional(), limit: z.number().int().positive().max(100).optional(), accountId: z.string().min(1).optional(), });