Custom Incident Impact Registration

Use this endpoint with the POST method to register Custom Incident Impact values.

Some teams track incidents outside of traditional Observability tools. Custom impact sources allow you to submit these values to Sleuth and get your Failure Rate and MTTR values.

Path

ENDPOINT

https://app.sleuth.io/api/1/deployments/ORG_SLUG/PROJECT_SLUG/ENVIRONMENT_SLUG/IMPACT_SOURCE_SLUG/register_impact/APIKEY

The endpoint path takes 4 slugs which direct the manual changes to the correct code project:

• ORG_SLUG: found in the URL of your Sleuth org, immediately following https://app.sleuth.io/

• PROJECT_SLUG: found in the URL, following the prefix https://app.sleuth.io/org_slug/

• ENVIRONMENT_SLUG: found at the end of the URL of your Sleuth org when navigating to the target project and selecting the target custom incident impact source: env_slug=ENVIRONMENT_SLUG

• IMPACT_SOURCE_SLUG: found in the URL of your Sleuth org when navigating to the target project and selecting the target custom incident impact source, just before the ?env_slug

The API key must also be added to the end of the path in this instance.

Parameters

Mandatory parameters

Name	Type	Comments
api_key*	string	Can be found in the Organization Settings -> Details -> Api Key field in your Sleuth org.
type*	string	Valid types are triggered, resolved, and reopened.

Optional parameters

Responses

Make sure you replace the values surrounded by< and >with your own values.

cURL with API key in Path

curl -X POST \
'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<PROJECT_SLUG>/<ENVIRONMENT>/<IMPACT_ID>/register_impact/<APIKEY>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "<TYPE>"
}'

PowerShell with API key in Path

Invoke-RestMethod -Method POST `
-Uri 'https://app.sleuth.io/api/1/deployments/<ORG_SLUG>/<PROJECT_SLUG>/<ENVIRONMENT>/<IMPACT_ID>/register_impact/<APIKEY>' `
-Headers @{
    'Content-Type' = 'application/json'
} `
-Body '{
    "type": "<TYPE>"
}'