Skip to main content

​
System Level Errors

When the Deck platform encounters an error, it returns a system level error response: 
{
  "job_guid": "67901dec-aea2-451d-abee-b44be31ae043",
  "error": {
    "error_code": "SystemError",
    "error_message": "Something went wrong"
  },
  "webhook_type": "Job",
  "webhook_code": "JobName",
  "environment": "Production"
}

​
Connection Errors

When there are issues with user authentication or connection establishment, errors are returned in the style of a system error: 
{
  "job_guid": "67901dec-aea2-451d-abee-b44be31ae043",
  "error": {
    "error_code": "InvalidCredentials",
    "error_message": "The credentials are invalid."
  },
  "webhook_type": "Job",
  "webhook_code": "EnsureConnection",
  "environment": "Production"
}

​
Job Execution Errors

When a job completes but encounters an error during execution, the error information is included in the job’s output. The success field on a job’s output also lets you know if the job completed it’s intended tasks as expected. 
{
  "job_guid": "67901dec-aea2-451d-abee-b44be31ae043",
  "output": {
    "success": false,
    "error_category": "JobFailed",
    "message": "Failed to complete JobName."
  },
  "webhook_type": "Job",
  "webhook_code": "JobName",
  "environment": "Production"
}