Configuring Cachet

Cachet is a free, open source status page for your API, service or company. The integration allows you to update component status on your Cachet page, and we have worked together to make the integration seamless. To get started, you will first need to set up a Cachet account at

Integration Functionality

  • When an alert is created in, a component is updated on your Cachet status page.
  • Response time metrics for your checks may be sent to and graphed on your Cachet status page.
  • This integration supports 15-minute metric intervals

Integration Setup

Three steps are required to complete the Integration with Cachet, and you will need to switch between your Cachet status page and throughout this process. Follow these steps to complete your Integration setup.

In order to activate the integration of Cachet within your account, go to Notifications>Integrations, then click New Profile. Select Cachet as the Provider Type when adding a new push notifications profile.

Obtain an API Token

Login to your Cachet status page, then click your avatar in the top left-hand corner. Scroll to the bottom of your Profile page and copy the API Token located there.

Return to, and paste the API Token into the corresponding field.

Copy the Root URL of Your Cachet Status Page Domain

Return to your Cachet status page, and copy the root URL. (E.G.

Return to, and paste the URL into the corresponding field.

Obtain Your Component and Metric IDs

To obtain the component and metric IDs from your Cachet status page, follow these steps:

  • For Component ID: Click Component, look for API, then click Edit. The Component ID is the part of the path before "/edit".
  • For Metric ID: Click Metric and then Edit your existing metric. The Metric ID is the part of the path before "/edit".

Copy each, then return to and paste them into the Component ID or Metric ID field.


Once you've configured your Cachet integration, you will need to assign it to a contact and make sure that contact is notified when a Check fails.

Assign Integration to Contacts

To add your integration to an existing contact, click on or type the name of the contact into the Assign to Contacts field within the integration setup screen. 

You can designate a new contact from within the integration setup. Simply enter the name of your new contact into the Assign to Contacts field, and select it as depicted below: will create a new contact and assign the integration to it. You can find this contact when you click Notifications>Contact.

Assign Integration Contact to a Check

If you have created a new or dedicated contact for your integration, you will need to add it to specific checks. If you have assigned the integration to a contact that is already assigned to one (or more) checks, you may skip this step.

Return to your Check’s Edit screen and assign this contact to the Contacts field to be notified of a downtime event. Metrics can appear in 15-minute intervals. On initial setup, metric data may take up to 30 minutes to initially appear.

Data for one or five-minute interval checks is shown in averages of 15 minutes, with more precise metrics and the option to download metrics available from This data also includes response time per location.

Please note: Response time data is stored based on account usage. stores hourly data for a maximum of 90 days, and daily check data for a period of up to 24 months.

Test Your Integration

Test your integration with one of the following two options:

  1. Force the Check assigned to your Integration to fail by altering it (HTTPS checks can use a misspelling of the domain, for example)
  2. Click Notifications>Contacts, then click Actions>Test to send a test to the Contact



Was this article helpful?
1 out of 2 found this helpful