Skip to main content

​
The catalog resource object

​
category
enum<string>
required

Which category of resource

Available options:
primitive,
custom,
external
Example:

"custom"

​
description
string
required

Human readable description for this resource

Example:

"Boolean true or false value"

​
engine_resource_type
string
required

The way this resource type is referenced in the engine, as used when setting the type of an alert attribute

Example:

"CatalogEntry[\"01GVGYJSD39FRKVDWACK9NDS4E\"]"

​
label
string
required

Label for this catalog resource type

Example:

"GitHub Repository"

​
type
string
required

Catalog type name for this resource, as used when setting the type of a catalog type attribute

Example:

"Custom[\"Team\"]"

​
value_docstring
string
required

Documentation for the literal string value of this resource

Example:

"Either the GraphQL node ID of the repository or a string of <owner>/<repo>, e.g. incident-io/website"