Docs

Get an event for a simulation run

Returns a simulation event using its ID.

GET /simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}
Returns a simulation event using its ID.

Requires notification_simulation.read permission.

Path parameters

simulation_idstringrequired
Paddle ID of the simulation entity to work with.
simulation_run_idstringrequired
Paddle ID of the simulation run entity to work with.
simulation_event_idstringrequired
Paddle ID of the simulation event entity to work with.

Response (200)

dataobjectrequired
Represents a simulation event.
idstringrequired
Example: ntfsimevt_01hvg8ykjrcdr4jvv9rqcbkhfa
Unique Paddle ID for this simulation event, prefixed with ntfsimevt_.
Pattern: ^ntfsimevt_[a-z\d]{26}$
statusstringrequired
Status of this simulation run log.
Values
  • pending
    Simulation run log is pending. Paddle hasn't yet tried to deliver the simulated event.
  • success
    Simulation run log was successful. Paddle delivered the simulated event successfully.
  • failed
    Simulation run log failed. Paddle tried to deliver the simulated event, but it failed. If response object is null, no response received from your server. Check your notification setting endpoint configuration.
  • aborted
    Simulation run log aborted. Paddle could not attempt delivery of the simulated event.
event_typestringrequired
Type of event sent by Paddle, in the format entity.event_type.
Values
+ Show all values
payloadobjectrequired
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 | nullrequired
Information about the request. Sent by Paddle as part of the simulation.
bodystringrequired
Request body sent by Paddle.
responseobject | nullrequired
Information about the response. Sent by the responding server for the notification setting.
bodystringrequired
Response body sent by the responding server. May be empty for success responses.
status_codenumberrequired
HTTP status code sent by the responding server.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Response
{
  "data": {
    "id": "ntfsimevt_01j82hf8jrwjsf9337a35tqghp",
    "status": "success",
    "event_type": "adjustment.updated",
    "payload": {
      "id": "adj_01hvgf2s84dr6reszzg29zbvcm",
      "items": [
        {
          "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj",
          "type": "partial",
          "amount": "100",
          "totals": {
            "tax": "8",
            "total": "100",
            "subtotal": "92"
          },
          "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw",
          "proration": null
        }
      ],
      "action": "refund",
      "reason": "error",
      "status": "pending_approval",
      "totals": {
        "fee": "5",
        "tax": "8",
        "total": "100",
        "earnings": "87",
        "subtotal": "92",
        "currency_code": "USD"
      },
      "created_at": "2024-04-15T08:48:20.239695Z",
      "updated_at": "2024-04-15T08:48:20.239695Z",
      "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
      "currency_code": "USD",
      "payout_totals": {
        "fee": "5",
        "tax": "8",
        "total": "100",
        "earnings": "87",
        "subtotal": "92",
        "currency_code": "USD"
      },
      "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y",
      "subscription_id": "sub_01hvccbx32q2gb40sqx7n42430",
      "credit_applied_to_balance": null
    },
    "request": {
      "body": "{\"event_id\":\"ntfsimevt_01j82hf8jrwjsf9337a35tqghp\",\"event_type\":\"adjustment.updated\",\"occurred_at\":\"2024-09-18T12:24:47.960617Z\",\"data\":{\"id\":\"adj_01hvgf2s84dr6reszzg29zbvcm\",\"items\":[{\"id\":\"adjitm_01hvgf2s84dr6reszzg2gx70gj\",\"type\":\"partial\",\"amount\":\"100\",\"totals\":{\"tax\":\"8\",\"total\":\"100\",\"subtotal\":\"92\"},\"item_id\":\"txnitm_01hvcc94b7qgz60qmrqmbm19zw\",\"proration\":null}],\"action\":\"refund\",\"reason\":\"error\",\"status\":\"pending_approval\",\"totals\":{\"fee\":\"5\",\"tax\":\"8\",\"total\":\"100\",\"earnings\":\"87\",\"subtotal\":\"92\",\"currency_code\":\"USD\"},\"created_at\":\"2024-04-15T08:48:20.239695Z\",\"updated_at\":\"2024-04-15T08:48:20.239695Z\",\"customer_id\":\"ctm_01hv6y1jedq4p1n0yqn5ba3ky4\",\"currency_code\":\"USD\",\"payout_totals\":{\"fee\":\"5\",\"tax\":\"8\",\"total\":\"100\",\"earnings\":\"87\",\"subtotal\":\"92\",\"currency_code\":\"USD\"},\"transaction_id\":\"txn_01hvcc93znj3mpqt1tenkjb04y\",\"subscription_id\":\"sub_01hvccbx32q2gb40sqx7n42430\",\"credit_applied_to_balance\":null}}"
    },
    "response": {
      "body": "{\"status\":\"SUCCESS\",\"message\":\"Request handled by Hookdeck. Check your dashboard to inspect the request: https://dashboard.hookdeck.com/requests/req_6ob9lGLoCA2qKWS6VGXR\",\"request_id\":\"req_6ob9lGLoCA2qKWS6VGXR\"}",
      "status_code": 200
    },
    "created_at": "2024-09-18T12:24:47.960617Z",
    "updated_at": "2024-09-18T12:24:48.309530Z"
  },
  "meta": {
    "request_id": "76421aed-4a64-4eb6-b14e-72407f5ec40e"
  }
}

Was this page helpful?