Paddle Billing
Search

Simulation run events

Notification simulation run events describe a simulated event that happened as part of a notification simulation run.

When you run a notification simulation using webhook simulator, Paddle sends simulated events to the notification destination set against the simulation and records information about the delivery attempt.

Notification simulation run events hold information like:

  • What kind of event was simulated.
  • Whether the event was delivered successfully.
  • When Paddle attempted to deliver it.
  • The payload of the simulated event.
  • The response from the destination server.

For scenario simulations, Paddle sends multiple events for each step of the scenario, like all the events that occur when a subscription is created.

Attributes

idstring

Unique Paddle ID for this simulation event, prefixed with ntfsimevt_.

statusstring

Status of this simulation run log.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

payloadobject

Simulation payload. Pass a JSON object that matches the schema for an event type to simulate a custom payload. If omitted, Paddle populates with a demo example.

requestobject or null

Information about the request. Sent by Paddle as part of the simulation.

bodystring

Request body sent by Paddle.

responseobject or null

Information about the response. Sent by the responding server for the notification setting.

bodystring

Response body sent by the responding server. May be empty for success responses.

status_codenumber

HTTP status code sent by the responding server.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

List events for a simulation run
Get an event for a simulation run
Replay an event for a simulation run
posthttps://api.paddle.com/simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}/replay