list_simulation_run_events
Retrieve and analyze simulation run events from Paddle to monitor delivery status, debug issues, and verify webhook responses.
Instructions
This tool will list simulation run events in Paddle.
Use the maximum perPage by default (200) to ensure comprehensive results. Filter simulationRunEvents by id as needed. Results are paginated - use the 'after' parameter with the last ID from previous results to get the next page. Sort and order results using the orderBy parameter.
Check the following details to understand the success or failure of the event according to Paddle and debug issues:
status: Status of the event according to Paddle.
pending: No attempt has been made to deliver the event yet.
success: The event was delivered successfully.
failure: Paddle tried to deliver the simulated event, but it failed. If response object is null, no response received from the server. Check the notification setting endpoint configuration.
aborted: Paddle couldn't attempt delivery of the simulated event.
payload: Payload sent by Paddle for this event within the simulation.
request.body: Request body sent by Paddle.
response.body: Response body sent by the responding server. May be empty for success responses.
response.statusCode: HTTP status code sent by the responding server.
If the destination URL is using a tunnel or proxy service, the response may be from the tunnel or proxy service, not the original server. Don't assume success or failure based on the status and response alone. Check the logs of the tunnel/proxy service and the destination server.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| simulationId | Yes | Paddle ID of the simulation entity associated with the run. | |
| simulationRunId | Yes | Paddle ID of the simulation run entity. | |
| after | No | Return entities after the specified Paddle ID when working with paginated endpoints. | |
| orderBy | No | Order returned entities by the specified field and direction. | |
| perPage | No | Set how many entities are returned per page. Returns the maximum number of results if a number greater than the maximum is requested. | |
| id | No | Return only the IDs specified. Use a comma-separated list to get multiple entities. |
Implementation Reference
- src/functions.ts:658-671 (handler)The handler function that executes the tool logic. It destructures simulationId and simulationRunId from params, lists simulation run events using the Paddle SDK, fetches the next page of events, computes pagination data, and returns both.export const listSimulationRunEvents = async ( paddle: Paddle, params: z.infer<typeof Parameters.listSimulationRunEventsParameters>, ) => { try { const { simulationId, simulationRunId, ...queryParams } = params; const collection = paddle.simulationRunEvents.list(simulationId, simulationRunId, queryParams); const simulationRunEvents = await collection.next(); const pagination = paginationData(collection); return { pagination, simulationRunEvents }; } catch (error) { return error; } };
- src/tools.ts:890-899 (registration)Tool registration defining the method name, human-readable name, description prompt, input parameters schema reference, and required actions (read/list simulationRunEvents).method: "list_simulation_run_events", name: "List events for a simulation run", description: prompts.listSimulationRunEventsPrompt, parameters: params.listSimulationRunEventsParameters, actions: { simulationRunEvents: { read: true, list: true, }, },
- src/api.ts:62-62 (registration)Maps the tool method constant (LIST_SIMULATION_RUN_EVENTS) to the handler function (funcs.listSimulationRunEvents) in the tool execution map.[TOOL_METHODS.LIST_SIMULATION_RUN_EVENTS]: funcs.listSimulationRunEvents,
- src/constants.ts:54-54 (helper)Constant defining the tool method string identifier used in registrations and mappings.LIST_SIMULATION_RUN_EVENTS: "list_simulation_run_events",
- src/prompts.ts:1033-1034 (helper)Prompt string providing guidance and documentation for using the list_simulation_run_events tool.If the destination URL is using a tunnel or proxy service, the response may be from the tunnel or proxy service, not the original server. Don't assume success or failure based on the status and response alone. Check the logs of the tunnel/proxy service and the destination server. `;