Create a simulation
Creates a new simulation for a notification setting (notification destination).
If successful, your response includes a copy of the new simulation entity.
Request Body
Name of this simulation.
Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.
Single event sent for this simulation, in the format entity.event_type.
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.
Response
Represents a simulation entity.
Unique Paddle ID for this simulation, prefixed with ntfsim_.
Whether this entity can be used in Paddle.
Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.
Name of this simulation.
Single event sent for this simulation, in the format entity.event_type.
Simulation payload.
RFC 3339 datetime string of when this simulation was last run. null until run. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
12345678910111213141516171819201{
2 "notification_setting_id": "ntfset_01j82d983j814ypzx7m1fw2jpz",
3 "name": "New US address created for CRM",
4 "type": "address.created",
5 "payload": {
6 "id": "add_01hv8gq3318ktkfengj2r75gfx",
7 "city": "New York",
8 "region": "NY",
9 "status": "active",
10 "created_at": "2024-04-12T06:42:58.785Z",
11 "first_line": "4050 Jefferson Plaza, 41st Floor",
12 "updated_at": "2024-04-12T06:42:58.785Z",
13 "custom_data": null,
14 "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
15 "description": "Head Office",
16 "import_meta": null,
17 "postal_code": "10021",
18 "second_line": null,
19 "country_code": "US"
20 }