Documentation menu

Documentation

Start here


This documentation covers setup, checks, the status page, notices and every integration. Each guide starts with what you need and ends with how to test it.

New to Tidepost? Follow the four steps below, then come back for the details.

Looking for the API? The reference lists every endpoint with an example request and the rate limit that applies.

Something unclear or out of date? Tell us from the contact page and we fix the guide, usually in the same week.

Guides by topic

Each guide starts with what you need and ends with a way to test it.

Checks and alerts

Intervals, timeouts, regions and who gets woken up when a check fails.

Status page

Your domain, logo and colors, components and what customers see in each state.

Incidents and updates

From the first update to the review, with templates for common outages.

Subscribers

Email, feeds and calendar, imports from other tools and how people unsubscribe.

API and webhooks

Every endpoint with an example request, signed webhooks and rate limits.

Accounts and security

Roles, single sign-on, the audit log and the data processing agreement.

  • Updated with every release
  • Examples you can copy
  • Every guide ends with a test
  • Written by the people who build Tidepost
  • English and German

Your first hour with Tidepost

01

Add a check

Start with the address customers open most, usually the login or the start page of your app.

02

Name components

Use the words your customers use. Nobody searches a status page for a server name.

03

Write a test incident

Post a private test update to see how it looks on the page and in email.

04

Go live

Connect your domain, then link the status page from your app and your support pages.