Skip to main content

The catalog entry object

aliases
string[]
required

Optional aliases that can be used to reference this entry

Example:
attribute_values
object
required

Values of this entry

Example:
catalog_type_id
string
required

ID of this catalog type

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

created_at
string<date-time>
required

When this entry was created

Example:

"2021-08-17T13:28:57.801578Z"

custom_aliases
string[]
required

Aliases your organisation has added to an entry of a catalog type that incident.io syncs, such as a schedule or escalation path, which you can't change aliases on directly. Syncs keep them, and they are also listed in aliases. When you update an entry, omit this or send null to keep its current custom aliases, send an empty list to clear them, or send a list to replace them.

Example:
id
string
required

ID of this catalog entry

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

name
string
required

Name is the human readable name of this entry

Example:

"Primary On-call"

rank
integer<int32>
required

When catalog type is ranked, this is used to help order things

Example:

3

updated_at
string<date-time>
required

When this entry was last updated

Example:

"2021-08-17T13:28:57.801578Z"

archived_at
string<date-time>

When this entry was archived

Example:

"2021-08-17T14:28:57.801578Z"

external_id
string

An optional alternative ID for this entry, which is ensured to be unique for the type

Example:

"761722cd-d1d7-477b-ac7e-90f9e079dc33"