Creates a new transaction check.

Request body

activeboolean

Check status: active or inactive

contact_idsinteger[]

Contacts to alert

custom_messagestring

Custom message that is part of the email and webhook alerts

intervalinteger

TMS test intervals in minutes. Allowed intervals: 5,10,20,60,720,1440. The interval you're allowed to set may vary depending on your current plan.

namestring required

Name of the check

regionstring

Name of the region where the check is executed. Supported regions: us-east, us-west, eu, au

send_notification_when_downinteger

Send notification when down X times

severity_levelstring

Check importance- how important are the alerts when the check fails. Allowed values: low, high

team_idsinteger[]

Teams to alert

integration_idsinteger[]

Integration identifiers.

tagsstring[]

List of tags for a check. The tag name may contain the characters 'A-Z', 'a-z', '0-9', '_' and '-'. The maximum length of a tag is 64 characters.

Example request

{
  "contact_ids": [
    12345678,
    19876654
  ],
  "custom_message": "My custom message",
  "interval": 20,
  "name": "My awesome check",
  "region": "us-west",
  "severity_level": "low",
  "steps": [
    {
      "args": {
        "url": "http://www.google.com"
      },
      "fn": "go_to"
    }
  ],
  "team_ids": [
    12345678,
    135790
  ],
  "integration_ids": [
    1234,
    1359
  ],
  "metadata": {
    "width": 1950,
    "height": 1080,
    "authentications": {
      "httpAuthentications": [
        {
          "credentials": {
            "password": "secret",
            "userName": "admin"
          },
          "host": "https://example.com/auth"
        }
      ]
    }
  },
  "tags": [
    "tag1",
    "tag2"
  ]
}

Response

Simplified description of an added check.

idinteger

Id of the check

namestring