View Message

Title

Message

Confirm

<< Discussions<< NewsReply

CheckCentral API Documentation: createCheck Endpoint

The CheckCentral API provides an endpoint for creating checks programmatically. All of the configuration options are available through the API, detailed below. To create a new check through the API, you will require an API token for your organization with Read/Write access. Organization administrators can create tokens through the API portal on your dashboard.

The endpoint is located at https://api.checkcentral.cc/createCheck/?apiToken=APITOKEN where the APITOKEN placeholder is replaced with your valid token. The request must be made with the Content-Type header set to application/json. The body of the request should contain as many of the properties listed below as required to define the check. Any properties not passed will be set to their default value.

For example, to create a new check that:

  • Receives messages at the address "demo+apicheck@mycheckcentral.cc"
  • Expects messages every two hours
  • Expects messages only on weekdays
  • Is set to Failure unless the message subject is "Message Success" or the message body has the text "No Errors Reported"

you would send the following json in the body of the request:

Code

The check data must include a name property, as well as at least one of email_alias and matching_conditions to allow the check to be matched against incoming messages.

The complete list of possible properties for check configuration are as follows:

Check Structure

Parameter Type/Allowed Values Default

name

The name for the new check.

The name parameter is required.

String

email_alias

The plus alias for the check. This will be used to generate the custom email address for the Check along with your organization account name: account_name+email_alias@mycheckcentral.cc.

At least one of the email_alias or matching_conditions parameters must be specified.

String

matching_conditions

The rules that will be used to match incoming messages. See the definition of a ConditionGroup below.

At least one of the email_alias or matching_conditions parameters must be specified.

ConditionGroup {}

group_id

The ID of the group to assign this check. IDs may be retrieved from the getGroups API endpoint.

String

description

A text description for the check.

String

interval_type

The interval unit CheckCentral will use to calculate the expected arrival time of incoming messages

One of:

  • minute
  • hour
  • day
  • week
  • month
day

interval_value

The number of interval units (see above) used when calculating the expected arrival of incoming messages.

Integer 1

overdue_minutes

How many minutes after the interval has elapsed CheckCentral will wait before flagging the check as failed.

Integer 30

window_start

An optional time of day when messages will begin to be received.

String 00:00

window_end

An optional time of day when messages will cease to be received.

String 00:00

active_days

Pass an array of days to indicate which days the check should expect to receive messages.

An array containing either "all", or any of:

  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
[ "all" ]

enabled_notifications

Pass an array of personal notification services to configure the check to send alerts via those services.

An array containing any of:

  • email
  • sms
  • push
  • pushbullet
  • pushover
[]

enabled_integrations

Pass an array of organization notification services to configure the check to send alerts via those services.

An array containing any of:

  • slack
[]

notify_returned_to_success

Checks with this flag will send an alert when they are restored to a success state by an incoming message.

Bool true

notify_outside_window

Checks with this flag set to false will only send alerts during the time window and active days configured above.

Bool true

notify_consecutive_failures

This parameter controls when CheckCentral will send alerts about failure messages.

One of:

  • always
  • first
  • after_n
  • every_nth
always

notify_consecutive_failures_limit

If notify_consecutive_failures is set to either after_n or every_nth, this parameter configures how many consecutive failures will trigger alerts.

Integer 1

notify_failure_grace_period

The number of minutes this check will wait to send alerts about failures. If the check is returned to successful status before this period elapses, any pending alerts will be cancelled.

Integer 0

default_status

The default status for incoming messages that don't match against any of the conditions below.

One of:

  • success
  • warning
  • failure
failure

success_conditions

The rules that determine whether incoming messages will be set to success. See the definition of a ConditionGroup below.

ConditionGroup {}

warning_conditions

The rules that determine whether incoming messages will be set to warning. See the definition of a ConditionGroup below.

ConditionGroup {}

failure_conditions

The rules that determine whether incoming messages will be set to failure. See the definition of a ConditionGroup below.

ConditionGroup {}

ConditionGroup

Parameter Type/Allowed Values Default

required_conditions

This parameter controls whether incoming messages must meet any or all of the conditions defined below to be considered a match.

One of:

  • all
  • any
"all"

condense_whitespace

If this flag is set, all of the conditions defined in this group will treat multiple whitespace characters as a single space.

Bool false

conditions

The list of conditions for this ConditionGroup to match messages against. See the definition of a Condition below.

Array[Condition] []

Condition

Parameter Type/Allowed Values Default

message_field

Which part of the incoming message will be examined for this condition.

One of:

  • subject
  • body
  • to
  • cc
  • attachments
  • attachment_text
  • from
  • originally_to
subject

matches

What matching rule this condition will use.

One of:

  • contains
  • not_contains
  • exactly
  • empty
  • not_empty
  • has_attachments
  • has_no_attachments
  • filename_contains
  • filename_not_contains
  • filename_exact
  • text_contains
  • text_not_contains
  • complex_match
  • complex_filename_match
  • complex_text_match
contains

value

The value to use with the above matching rule and message component.

String
Feb 21, 2019 (modified Mar 19, 2019)  • #1
Was this helpful?  Login to Vote  Login to Vote
<< Discussions<< NewsReply