Provisioning Scenarios
Provisioning Validation Failure Example
- Pax8 Sends Webhook and creates a
ProvisionAttempt
- Provisioner API returns HttpStatus
200
,201
, or202
- No validation should occur during this step. This is simply to let Pax8 know whether the Provision Notification was received.
- Pax8 marks the
ProvisionAttempt
asAcknowledged
- Provisioner processes the request asynchronously. During processing, it is determined that the request cannot be processed as is. An example of this could be, the email provided by the user is already in use for another account.
- Provisioner posts a
ProvisionResult
for theProvisionAttempt
with aFail
status and anerrorMessage
detailing what went wrong such asvendorAdminEmail in use by another account
Provisioning Success Example
- Pax8 Sends Webhook and creates a
ProvisionAttempt
- Provisioner API returns HttpStatus
200
,201
, or202
- Pax8 expects the Provisioner API to simply acknowledge the Provision Notification. The Provisioner API should not do any synchronous processing or validation at this time.
- Pax8 marks the
ProvisionAttempt
as acknowledged - Provisioner processes the request asynchronously. At this time that would include validating request data, and then provisioning services.
- Provisioner posts a
ProvisionResult
for theProvisionAttempt
with aSuccess
status.
Transient Error Example
If our initial Provision Notification webhook fails, Pax8 employs a retry mechanism. 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.
- Pax8 Sends Webhook and creates
ProvisionAttempt_1
- Provisioner API does not respond with an acceptable status code (200, 201, 202)
- Pax8 marks
ProvisionAttempt_1
as failed - Pax8 Sends Webhook and creates a
ProvisionAttempt_2
- Provisioner API returns HTTPStatus
200
- Pax8 marks the
ProvisionAttempt_2
as successful - Provisioner returns a
ProvisionResult
forProvisionAttempt_2
Updated 1 day ago