Skip to main content
POST
/
simulations
/
{simulation_id}
/
runs
/
{simulation_run_id}
/
events
/
{simulation_event_id}
/
replay
Replay an event for a simulation run
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}/replay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ntfsimevt_01j82j3tr93j99gfv26tsngc27",
    "status": "pending",
    "event_type": "address.created",
    "payload": {
      "id": "add_01hv8gq3318ktkfengj2r75gfx",
      "city": "New York",
      "region": "NY",
      "status": "active",
      "created_at": "2024-04-12T06:42:58.785Z",
      "first_line": "4050 Jefferson Plaza, 41st Floor",
      "updated_at": "2024-04-12T06:42:58.785Z",
      "custom_data": null,
      "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
      "description": "Head Office",
      "import_meta": null,
      "postal_code": "10021",
      "second_line": null,
      "country_code": "US"
    },
    "request": null,
    "response": null,
    "created_at": "2024-09-18T12:36:01.929359Z",
    "updated_at": "2024-09-18T12:37:35.659788Z"
  },
  "meta": {
    "request_id": "0369cb98-380b-40a9-bfd8-8ac4856c05f6"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

simulation_id
string
required

Paddle ID of the simulation entity to work with.

Example:

"ntfsim_01gt261ms8ew72a0vnm5p5ne2q"

simulation_run_id
string
required

Paddle ID of the simulation run entity to work with.

Example:

"ntfsimrun_01gt261ms8ew72a0vnm5p5ne2q"

simulation_event_id
string
required

Paddle ID of the simulation event entity to work with.

Example:

"ntfsimevt_01gt261ms8ew72a0vnm5p5ne2q"

Response

Accepted

data
SimulationEvent · object
required

Represents a simulation event.

meta
Meta · object
required

Information about this response.