Overview

A ProvisionAttempt represents a record of an attempt to provision a ProvisionRequest using a ProvisionDetail.

Endpoints

Get All Provision Attempts for a Provision Request

• Get All ProvisionAttempts for a ProvisionRequest
  • If provisionDetailId is provided, it returns the attempts for that specific provision detail
  • If provisionDetailId is not provided, it returns all attempts for the provision request
• GET /provision-requests/{provisionRequestId}/attempts?provisionDetailId={provisionDetailId}

Get Provision Attempt by ID

• Retrieves a ProvisionAttempt for a ProvisionRequest
• GET /provision-requests/{provisionRequestId}/attempts/{provisionAttemptId}

Get Latest Provision Attempt for a Provision Request

• Get Latest ProvisionAttempt for a Provision Request
• GET /provision-requests/{provisionRequestId}/attempts/latest

Create Provision Attempt for a Provision Request and Provision Detail

• Create Provision Attempt for a Provision Request and Provision Detail
  • Use this endpoint to create a new Provision Attempt for a given unfulfilled provision request. This can be useful if you want to retry a failed or otherwise unfulfilled provision request.
  • This action is disallowed if the target provision request is already fulfilled, meaning there is already a successful provision result associated with it
  • The newly created provision attempt will automatically have an Acknowledged status
• POST /provision-requests/{provisionRequestId}/attempts

The Provision Attempt Object

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "provisionDetailId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "webhookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "string",
    "errorDetail": "string",
    "createdDate": "2025-08-01T20:12:54.968Z"
}

Additional Information

Statuses

Possible status of a ProvisionAttempt is Issued, Acknowledged, or Failed. errorDetail will be null for successful attempts.

• Issued - After Pax8 sends the Provision Notification we record this attempt as being issued.
• Acknowledged - If Pax8 receives a 200, 201, or 202 status from your webhook endpoint, we record this attempt as Acknowledged.
• Failed - If Pax8 receives an unacceptable status code from your webhook endpoint, we will record this as a Failed attempt and you will not be able to provide us with a ProvisionResult.

Nuances

• A ProvisionRequest and ProvisionDetail may have many associated ProvisionAttempts. Pax8 creates a ProvisionAttempt whenever we notify the Provisioner of an order via webhook.
• Each ProvisionAttempt contains a webhookId which indicates the Webhook Configuration associated with the ProvisionAttempt.
• Information about how to configure webhooks may be found on the Webhook Configuration page.

Retries

If our initial Provision Notification Webhook does not succeed with a 200, 201, or 202, Pax8 employs a retry mechanism. Here's how retries work:

• Pax8 will automatically retry the webhook delivery up to three times.
• Each retry creates a new ProvisionAttempt, allowing for a total of four attempts, the initial attempt plus three retries.