Retrieving Failure Reasons via API

Failure reasons allow you to translate the reason for failure to a user or system to either inform or prompt remediating action.

How to Retrieve Failure Reasons

  1. job-state-changedwebhook posts a status of "failed".
  2. Query the Show Job Details endpoint with the Job ID from the job-state-changed webhook payload.
  3. The failure_reason value will contain the reason the job failed, which can be used to present action to the customer.

To see a list of possible failure reasons, check this guide: [there will be a link here to the child page of this page]