Sleuth Documentation
HomeBlogSupportSign up
  • Getting started
  • Navigating Sleuth
  • DORA metrics
    • Deploy frequency
    • Change lead time
    • Change failure rate
    • MTTR
    • Interpreting Metrics in Sleuth
  • Deployment tracking
    • Organization
      • Labels
      • Trends
      • Compare
      • Search
      • Status
    • Projects
      • Issue trackers
    • Environments
    • Code deployments
      • Creating a deployment
      • How to register a deploy
      • Rollbacks
      • Automatic tagging
      • Deployment locking
      • Environment drift
      • Move code deployments
      • Search everything
    • Feature flags
    • Manual changes
    • Deploys
    • Teams
  • Work in Progress
  • Goals
  • Sleuth Automations
    • Automations Marketplace
      • Installing Automations
        • Installing PR "Update" Automations
      • Editing and uninstalling Automations
      • Smart suggestions
      • Understanding efficacy
    • Custom Automations
      • Automations Cookbook
      • Webhook Actions
      • Trigger Build Actions
        • Bitbucket Pipelines
        • CircleCI
        • Github Actions
        • Jenkins
  • Slack & Email Notifications
  • Auto-verify deploys
    • Anomaly detection
    • Error impact
    • Metric impact
  • Ignoring pull requests
  • Slack mission control
    • Approvals
    • Project notifications
    • Personal notifications
    • Search Sleuth in Slack
    • Project/Deployment history
    • Developer standup
  • Sleuth API
    • Deploy Registration
    • Deploy import
    • Manual Change
    • Custom Incident Impact Registration
    • Custom Metric Impact Registration
    • Deprecation information
    • GraphQL Queries
    • GraphQL Mutations
    • Query batching
  • Integrations
    • About Integrations...
    • Code integrations (read-only)
      • Azure DevOps
      • Bitbucket
      • GitHub
      • GitLab
      • Custom Git
      • Terraform Cloud
    • Code integrations (write)
    • Feature flag integrations
      • LaunchDarkly
    • Impact integrations
      • Error trackers
        • Bugsnag
        • Honeybadger
        • Rollbar
        • Sentry
      • Metric trackers
        • AppDynamics
        • AWS CloudWatch
        • Custom
        • Datadog
        • Jira metrics (Cloud / Data Center)
        • NewRelic
        • SignalFx
      • Incident tracker integrations
        • Blameless
        • PagerDuty
        • Datadog Monitors
        • Statuspage
        • Opsgenie
        • Jira (Cloud/Data Center)
        • FireHydrant
        • Rootly
        • ServiceNow
        • Custom
          • Grafana OnCall
      • CI/CD builds
        • Azure Pipelines
        • Bitbucket Pipelines
        • Buildkite
        • CircleCI
        • GitHub Actions
        • GitLab CI/CD Pipelines
        • Jenkins
    • Sleuth DORA App for Slack
    • Microsoft Teams integration
    • CI/CD integrations
      • Azure Pipelines
      • Bitbucket Pipelines
      • Buildkite
      • CircleCI
      • Github Actions
      • GitLab CI/CD Pipelines
      • Jenkins
    • Issue tracker integrations
      • Jira Cloud
      • Jira Data Center
      • Linear
      • Shortcut
    • Fixing broken integrations
  • Pulse
    • Welcome to Pulse docs
    • Quick Start setup guide
    • Beginner tutorials
      • 1. How to create a Teamspace
      • 2. How to create a Review
      • 3. How to create a Survey
  • Features
    • Reviews
      • Review workflow
      • Review templates
      • Widgets and Sections
        • Widget type
      • Review settings
    • Surveys
      • Survey Workflow
    • Teamspaces
    • Inbox
    • AI assistant
    • General settings
      • Users and Teams
      • Investment mix
  • Settings
    • Organization settings
      • Details
      • Authentication
        • SAML 2.0 Setup
          • Okta Configuration
          • Azure AD Configuration
          • PingIdentity Configuration
      • Access Tokens
      • Members
      • Team Settings
      • Billing
    • Project settings
      • Details
      • Slack settings
      • Environment settings
      • Code deployment settings
      • Feature flag settings
      • Impact settings
    • Account settings
      • Account settings
      • Notifications settings
      • Identities settings
    • Role Based Access Control
  • Resources
    • FAQ
    • Sleuth TV
    • Purchasing
    • About Sleuth...
Powered by GitBook
On this page
  • Path
  • Parameters

Was this helpful?

  1. Sleuth API

Custom Incident Impact Registration

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

PreviousManual ChangeNextCustom Metric Impact Registration

Last updated 2 years ago

Was this helpful?

Some teams track incidents outside of traditional Observability tools. 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

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.

Name
Type
Comments

id

string

The unique incident identifier from your system.

date

string

ended_date

string

Use it with "type": "triggered" to register past incident event.

title

string

The human-readable title of the incident.

url

string

URL to the incident in your external system.

Code
Comments
Response Text

200

Manual change registered successfully.

Success

400

Returned if any of the input parameters are invalid, e.g.: - date format isn't valid - value is not a valid float

The response text will indicate the nature of the error:

Bad Request - impact value must be a number

401

Returned if the API key provided doesn't exist.

Unauthorized

404

Returned if the IMPACT_ID does not exist.

MetricImpactSource Not Found

429

Returned if your requests are more frequent than one every 120 seconds. A Retry-After header is provided with the number of seconds you should wait until you try again.

You may only register a custom metric once every 120 seconds

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>"
}'

The date the event occurred. Defaults to the current time.

The date the event ended.

Custom impact sources
ISO 8601
ISO 8601