Incident.io
By integrating Incident.io with DX, you can analyze incident data and metrics such as MTTR and Change Fail Rate, as well as incorporate incident data into DX scorecards. Please refer to the API documentation below and our schema explorer to see what data DX imports.
Prerequisites
To connect Incident.io to DX, you need:
- an API key
- ID of the custom field that holds service names in your Incident.io Catalog
Setup instructions
Follow the steps below to connect Incident.io to DX.
Step 1
Log in to incident.io and navigate to Settings > API keys.
Step 2
Create a new API key with two permissions:
- View data, like public incidents and organization settings
- View catalog types and entries
Step 3
If you have a service catalog in IncidentIO, find the ID of the Custom Field that is linked to your Catalog data in order to associate incidents with services in DX.
Step 4
- Navigate to the connections page in DX and select “+ Connection” in the top right.
- Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.
- Optional: Check “Disable incident write” to exclude Incident.io incidents from ingestion into DX’s unified schema (incidents won’t appear in out-of-the-box reports).
API reference
The table below lists the specific API endpoints that are used by DX.
Endpoint | Documentation |
---|---|
/workspaces | Link |
/workspaces/{workspace_id}/tasks/search | Link |
/users | Link |
/teams/{team_id}/projects | Link |
/workspaces/{workspace_id}/teams | Link |
/teams/{team_id}/team_memberships | Link |
/projects/ | Link |
/tasks/{task_id}/status_updates | Link |
/tasks/{task_id}/stories | Link |
/projects/{project_id}/sections | Link |
/workspaces/{workspace_id}/custom_fields | Link |
Errors
The table below lists potential error codes when adding a connection in DX.
Error | Description |
---|---|
invalid_credentials |
Your API credentials entered are not valid. |
invalid_permissions |
Your API token does not have the permissions required by DX. |
invalid_configuration |
The catalog_type_id wasn’t found in the custom fields list. |