The Error object - Conductor Docs

message

string

required

The primary error message. Use this for logs, developer/admin surfaces, and debugging.

Example:

"Invalid API key provided: 'sk_live_...1234'"

userFacingMessage

string

required

The user-friendly error message intended for end-user UI.

This value exists for every error. It may match error.message, or it may mask details that are only useful to developers or administrators, such as invalid API keys, billing issues, or setup problems. In masked cases, it may say "An internal server error occurred. Please try again."

Example:

"An internal server error occurred. Please try again."

type

enum<string>

required

The type of error that occurred.

Available options:

INTEGRATION_ERROR,

INTEGRATION_CONNECTION_ERROR,

INVALID_REQUEST_ERROR,

AUTHENTICATION_ERROR,

PERMISSION_ERROR,

INTERNAL_ERROR

Example:

"AUTHENTICATION_ERROR"

code

string

required

The unique error code from Conductor, which is useful for adding special handling for specific errors. E.g., 'RESOURCE_MISSING', 'API_KEY_INVALID', or 'QBD_REQUEST_ERROR'. In contrast, the error field type is more general and categorizes the error.

Example:

"API_KEY_INVALID"

httpStatusCode

number

required

The HTTP status code of the response that returned this error.

Example:

401

requestId

string

required

The unique identifier for the request that returned this error.

If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Example:

"req_1234567890"

integrationCode

string

The unique error code supplied by the third-party integration for errors returned by the integration (e.g., QuickBooks Desktop) or integration connector (e.g., Web Connector). This is useful for adding special handling for specific errors from the third-party integration or connector.

Example:

"0x80040420"