A key-value pair, where the key is the unique ID for the error and the value is the raw error message itself:

replication-key-type: "[DATA_TYPE] is not a supported replication key type"

Note: The raw error message should be generic. Replace anything specific like table or column names with placeholders enclosed in brackets. For example: [TABLE_NAME]

The raw error message.

Example values:

• ERROR: must be owner of relation [TABLE_NAME]
• SKIPPING Malformed sheet: [sheet_name]
• You do not have permission to access this type of transaction.

A unique ID for the error message. This is used to generate an anchor, which creates a direct link to the documentation for the error.

This should be short and descriptive; hyphens should take the place of spaces.

Example values:

• malformed-sheet
• empty-sheet
• schema-permission-denied

The integration(s) or destination(s) the error pertains to.

Example values:

• Amazon Redshift destinations
• GitHub integrations

The urgency level of the error. The level of an error determines how Stitch behaves when the error is encountered:

• info - Data has been replicated or loaded, and information is simply being logged
• warning - Data has been replicated or loaded, but something may require attention
• critical - Data can’t be replicated and/or loaded and intervention is required

Must be one of the following:

• info
• warning
• critical

A short description of the broad category the error falls into.

For example: An error describing insufficient permissions for a database might have a category of Database user privileges

Example values:

• Database user privileges
• Connection settings

A link to documentation about the error category. For example:

category: "Log-based Incremental Replication"
category-doc: |
  {{ link.replication.log-based-incremental | prepend: site.baseurl }}

If provided, this value and the category value are used to create a link. This value should be formatted as a full URL such as https://www.stitchdata.com, or an internal Stitch Docs link.

Applicable to integrations only. The version(s) of the integration the error is applicable to. This value should be an integer.

Example values:

• 1
• 2

A summary of the error. This is used by the page’s layout to generate a section heading for the error.

Example values:

• Database doesn't exist
• Cannot create new schema
• Insufficient schema privileges

A description of what caused the error. This can be written using Markdown or HTML.

For example:

Stitch is not the owner of a table in Amazon Redshift, which is required to perform functions necessary to load data.

Instructions for how to resolve or work around the error. This can be written in Markdown or HTML and should include links to relevant documentation, if any exists.

For example:

Verify that the database user authorizing the connection has all the required privileges as outlined in the [Amazon Redshift setup instructions]({{ link.destinations.setup.redshift | prepend: site.baseurl | append: "#create-database-user" }}).