Skip to main content

incident.io

CatalogScorecards

Summary​

incident.io is an incident management platform. You can use incident.io to drive insights into values such as:

  • Past incidents

Setup​

In order to connect Cortex to your incident.io instance, you’ll need to create a incident.io API Key in the API keys page in Settings with the following scopes:

  • Can view all incident data, including private incidents
  • Can view data, like public incidents and organisation settings
  • Can view catalog types and entries
  • Can create incidents

Add it under Settings → incident.io.

caution

If you do not see the Settings page you're looking for, you likely don't have the proper permissions and need to contact your admin.

Incident management​

Discovery​

By default, Cortex will try to "best-guess" the corresponding custom field value in incident.io for all catalog based custom fields. Cortex first looks up a custom field values using the name (e.g. My Service), then the entity identifier (e.g. my-service). For example, if your entity name is “My Service”, then the corresponding custom tag field in incident.io should either be “My Service” or "my-service."

Entity descriptor​

If you need to override the automatic discovery, you can define the following block in your Cortex entity descriptor.

x-cortex-incident-io:
  customFields:
  - name: Service # this is the customFieldName
    value: My Service
    alias: my-default-alias # alias is optional and only relevant if you have opted into multi account support
  - id: Service_ID # this is the customFieldId
    value: my-service
    alias: my-other-alias # alias is optional and only relevant if you have opted into multi account support