Request and Response Examples
Full Net New Example
Below is an example of specifying a custom simulation event for Provision Notification with a NetNew Provision Request type.
If you specify every single field in the order events body like the request below, all of the information will be echoed back to you in the Provision Notification that Pax8 sends you.
curl --request POST \
--url https://api.pax8.com/v2/provision-simulations/order-events \
--header 'accept: */*' \
--header 'authorization: Bearer TOKEN' \
--header 'content-type: application/json' \
--data '
{
"provisionRequest": {
"partnerAddress": {
"street": "123 Fake Street",
"city": "Best City",
"street2": "Unit 3",
"postcode": "11111",
"country": "US",
"stateOrProvince": "Colorado"
},
"companyAddress": {
"stateOrProvince": "CO",
"country": "US",
"postcode": "22222",
"city": "Best City",
"street2": "Suite 7",
"street": "987 Real Street"
},
"commitment": {
"term": {
"months": 12,
"endDate": "2025-04-08T19:54:03Z"
},
"volume": {
"minAmount": 150,
"maxAmount": 250,
"unitOfMeasure": "Points",
"months": 1
}
},
"partnerName": "Super Partner",
"partnerDomain": "super.partner",
"companyName": "Great Company",
"companyDomain": "great.company",
"productName": "Best Product",
"quantity": 7,
"type": "NetNew",
"commitmentTermMonths": 12,
"billingTerm": "Annual",
"id": "13451896-985d-49c2-830d-b852aa6b5e40",
"partnerId": "1427aef1-3c96-4ee2-ba2c-2802a2e15da1",
"partnerEnrollmentId": "42aeb583-e0b5-41bf-a5f9-76fce7e6dff6",
"companyId": "d49d261f-b802-41bb-ba73-0dbdd22ddcdd",
"productId": "75015627-3163-4972-aaae-3e9930e67f81",
"subscriptionId": "9f4a34a9-37ca-439e-a89c-2013f42b49e2",
"createdDate": "2024-04-08T19:54:03Z",
"commitmentTermEndDate": "2025-04-08T19:54:03Z"
},
"provisionDetail": {
"details": {
"someKey": "someValue"
},
"id": "8fd85e8e-27d7-45f3-ac73-a64826c42a95",
"provisionRequestId": "de53ef36-afef-4172-90a6-5611ae06e5b6",
"createdDate": "2025-04-08T19:54:11Z"
},
"provisionAttempt": {
"id": "06ac5243-d257-446c-8c80-bf59f18a7aac",
"provisionDetailId": "8fd85e8e-27d7-45f3-ac73-a64826c42a95",
"webhookId": "dd15fbf3-8004-4423-90c7-4ff35171fe5d",
"status": "Issued",
"createdDate": "2025-04-08T19:54:11Z"
},
"isSimulation": true
}
'
{
"provisionRequest": {
"id": "0b858eb9-13b5-468d-850d-192192d1359b",
"partnerId": "1427aef1-3c96-4ee2-ba2c-2802a2e15da1",
"partnerName": "Super Partner",
"partnerDomain": "super.partner",
"partnerAddress": {
"street": "123 Fake Street",
"street2": "Unit 3",
"city": "Best City",
"postcode": "11111",
"country": "US",
"stateOrProvince": "Colorado"
},
"partnerEnrollmentId": "42aeb583-e0b5-41bf-a5f9-76fce7e6dff6",
"companyId": "d49d261f-b802-41bb-ba73-0dbdd22ddcdd",
"companyName": "Great Company",
"companyDomain": "great.company",
"companyAddress": {
"street": "987 Real Street",
"street2": "Suite 7",
"city": "Best City",
"postcode": "22222",
"country": "US",
"stateOrProvince": "CO"
},
"productId": "75015627-3163-4972-aaae-3e9930e67f81",
"productName": "Best Product",
"quantity": 7,
"subscriptionId": "9f4a34a9-37ca-439e-a89c-2013f42b49e2",
"type": "NetNew",
"createdDate": "2025-08-05T20:01:22.600597346Z",
"commitmentTermMonths": 12,
"commitmentTermEndDate": "2025-04-08T19:54:03Z",
"commitment": {
"term": {
"months": 12,
"endDate": "2025-04-08T19:54:03Z"
},
"volume": {
"minAmount": 150,
"maxAmount": 250,
"unitOfMeasure": "Points",
"months": 1
}
},
"billingTerm": "Monthly"
},
"provisionDetail": {
"id": "fd0f9e2f-1f7a-4281-8f0b-2102945cc5a8",
"provisionRequestId": "0b858eb9-13b5-468d-850d-192192d1359b",
"details": {
"someKey": "someValue"
},
"createdDate": "2025-08-05T20:01:22.600605046Z"
},
"provisionAttempt": {
"id": "e9577538-733d-4335-9a97-649de1fa45b1",
"provisionDetailId": "fd0f9e2f-1f7a-4281-8f0b-2102945cc5a8",
"webhookId": "a3ee5fab-a1ee-4035-99b1-210a8c729269",
"status": "Acknowledged",
"createdDate": "2025-08-05T20:01:22.600612546Z"
},
"isSimulation": true
}
After POSTing the Order Event, you will receive a Provision Notification from the Pax8 simulation at the URL specified in your latest simulation Webhook Configuration.
Empty or Partial Example
Since every field in the payload to the order events page is optional, it is possible to POST to the order events endpoint with an empty request body, and Pax8 will auto generate values for anything that was absent. For example, if you make a request like the one below:
POST /provision-simulations/order-events
{}
curl --request POST \
--url https://api.pax8.com/v2/provision-simulations/order-events \
--header 'accept: */*' \
--header 'authorization: Bearer TOKEN' \
--header 'content-type: application/json'
'
You would still receive a full response from the order events endpoint, and you would still receive a full webhook, like in the previous example, only all the values will have been generated by the Pax8 system according to the defaults listed above these examples.
You can also omit or include any number of the fields from the body. If, for example, you only care to to test that your system can ingest certain provision detail keys called adminEmail and adminPhone, you could send an order events request that looks like this:
curl --request POST \
--url https://api.pax8.com/v2/provision-simulations/order-events \
--header 'accept: */*' \
--header 'authorization: Bearer TOKEN' \
--header 'content-type: application/json' \
--data '
{
"provisionDetail": {
"details": {
"adminEmail": "[email protected]",
"adminPhone": "800-555-7777"
}
}
}
'
In this case, the webhook you receive from Pax8 will have auto generated default values for everything except these provision details. It might look like this:
{
"provisionRequest": {
"id": "be407b00-1e6d-4739-ac7c-dd41bd04e6ac",
"partnerId": "ad9b2e3c-2e35-4226-8017-0aac3663e0a6",
"partnerName": "Example Partner Name",
"partnerDomain": "example.com",
"partnerAddress": {
"street": "123 Partner Ave.",
"street2": "Unit B",
"city": "Denver",
"postcode": "80210",
"country": "US",
"stateOrProvince": "CO"
},
"partnerEnrollmentId": "3d124400-b40a-4cd6-9d3f-0973cf5b7493",
"companyId": "5aa65974-255e-462b-a632-73ffbe1fd82e",
"companyName": "Example Company Name",
"companyDomain": "example.com",
"companyAddress": {
"street": "123 Company Ave.",
"street2": "Unit C",
"city": "Denver",
"postcode": "80210",
"country": "US",
"stateOrProvince": "CO"
},
"productId": "6be72f2f-b4d1-42f8-bd3d-0c595d515ab7",
"productName": "Product ABC",
"quantity": 1,
"subscriptionId": "bd91fa57-5b1a-46c0-9829-73d92b5955a9",
"type": "NetNew",
"createdDate": "2025-08-05T20:07:40.934630911Z",
"commitmentTermMonths": 25,
"commitmentTermEndDate": "2027-09-05T20:07:40.934563560Z",
"commitment": {
"term": {
"months": 25,
"endDate": "2027-09-05T20:07:40.934563560Z"
},
"volume": {
"minAmount": 1,
"maxAmount": 10,
"unitOfMeasure": "Users",
"months": 25
}
},
"billingTerm": "Monthly"
},
"provisionDetail": {
"id": "c1823834-140b-49c9-8011-5973d9c70a3f",
"provisionRequestId": "be407b00-1e6d-4739-ac7c-dd41bd04e6ac",
"details": {
"adminEmail": "[email protected]",
"adminPhone": "800-555-7777"
},
"createdDate": "2025-08-05T20:07:40.934637531Z"
},
"provisionAttempt": {
"id": "3478a020-bc92-4585-a553-10cdc2a7d982",
"provisionDetailId": "c1823834-140b-49c9-8011-5973d9c70a3f",
"webhookId": "a3ee5fab-a1ee-4035-99b1-210a8c729269",
"status": "Acknowledged",
"createdDate": "2025-08-05T20:07:40.934643941Z"
},
"isSimulation": true
}
Notice how all of the fields have their default values except in the details map, where the details you specified in the initial request are echoed back just as you entered them.
Updated 23 days ago