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"
}

​
Example Errors

Error CodeDescription
ActionRejectedThe requested action was rejected by the system or source.
BlockedThe operation was blocked due to security policies or rate limiting.
InputValuesThe input values provided are invalid or missing required fields.
JobCanceledThe job was canceled before it completed. Most often occurs when you call the CloseConnection job while another job is running.
NotFoundThe requested resource, endpoint, or entity could not be found.
TimeoutThe operation took longer than the allowed time and timed out.
SystemErrorA system-level error occurred on the Deck platform.
UnexpectedAn unexpected error occurred that does not fit into other error categories.

​
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"
}

​
Example Errors

Error CodeDescription
AuthMethodInvalidThe specified authentication method is not supported or is invalid for this source.
InputValuesThe provided input values are invalid or missing required fields.
InvalidCredentialsThe authentication credentials provided are incorrect.
MfaCodeInvalidThe Multi-Factor Authentication code entered is incorrect or has expired.
MfaTimeoutThe Multi-Factor Authentication process timed out before the user provided a response.
TimeoutThe authentication process took longer than the allowed time and timed out.
SystemErrorAn unexpected system error occurred during the connection attempt.

​
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 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"
}

​
Example Errors

Error CodeDescription
AccountNotFoundThe specified account could not be located or does not exist.
JobFailedThe job execution failed due to an agent error or unexpected condition.
JobNotSupportedThe requested job type is not supported for this source or connection.
JobOutcomeUnknownThe outcome of the job execution is inconclusive.
InputInvalidThe input provided for the job is invalid, incomplete, or does not match the expected schema.
ResourceNotFoundThe specified resource required for the job could not be found.
ResourceNotReadyThe resource required for the job is not ready or available at this time.