Subscribe to service status changes with RSS or Atom feeds

RSS Feeds

Telegram

The Statusfield REST API (v2) gives you read-only, programmatic access to the same <ServiceCount /> vendor status catalog that powers your dashboard and alerts. Every endpoint returns JSON, is authenticated with a Bearer token, and is served from the base URL https://statusfield.com.

Use it to check whether a service is degraded, list the monitors in your workspace, or pull a live snapshot of everything currently down.

<Callout variant='info' title='Paid Plan Required'>
  The API is available on the Hobby plan and up. It is not available on the
  Free plan — Free-plan keys return 403 planrestriction. Upgrade your
  plan to get started.
</Callout>

Authentication

All endpoints require an API key passed as a Bearer token:

<Steps>
  <Step title="Create a Key">
    Go to Settings → Integrations → API Keys
    and create a new key. The key is shown only once at creation time, so copy
    it somewhere safe. You can revoke a key from the same screen at any time.
  </Step>

  <Step title="Make Your First Call">
    Pass the key in the Authorization header on every request:

    

  </Step>
</Steps>

Keys are scoped to the workspace that created them. Rate limits, quotas, and available features all follow that workspace's plan.

Rate Limits & Quota

Limits are enforced per workspace per minute, with a per-second burst ceiling. The X-RateLimit-Limit and X-RateLimit-Remaining headers are returned on every response. When you exceed a limit you get 429 ratelimited along with a Retry-After (seconds) header.

| Plan  | Requests / minute | Burst (requests / second) | Requests / month |
| ----- | :---------------: | :-----------------------: | :--------------: |
| Free  | — (no API access) |             —             |        —         |
| Hobby |        10         |             2             |     100,000      |
| Pro   |        30         |             5             |     500,000      |
| Team  |        100        |            10             |    2,000,000     |

The monthly quota is enforced per workspace and tracked in the database, so it survives restarts and is accurate across instances. For plans with a finite cap, responses include X-Quota-Limit, X-Quota-Remaining, and X-Quota-Reset (ISO timestamp of the next UTC-month reset) headers. Exceeding the cap returns 429 quotaexceeded. The monthly counter resets at the start of each UTC month.

<Callout variant='info' title='Check the Headers'>
  Read X-RateLimit-Remaining to pace short bursts and X-Quota-Remaining to
  track your monthly budget. On a 429, honor Retry-After before retrying.
</Callout>

Error Shape

All errors follow the same JSON shape:

| HTTP Status | error code         | Meaning                                              |
| ----------- | -------------------- | ---------------------------------------------------- |
| 400         | badrequest        | Missing or invalid parameter (e.g. slug)             |
| 401         | unauthorized       | Missing Authorization header or invalid key format |
| 401         | invalidkey        | API key not found                                    |
| 403         | banned             | Account suspended or inactive                        |
| 403         | expired            | Temporary access expired                             |
| 403         | planrestriction   | Feature not available on current plan                |
| 404         | notfound          | Resource does not exist                              |
| 405         | methodnotallowed | Wrong HTTP method                                    |
| 429         | ratelimited       | Rate limit exceeded; see Retry-After               |
| 429         | quotaexceeded     | Monthly request quota exceeded                       |

List Services

GET /api/v2/services

List the Statusfield service catalog with optional filtering and cursor-based pagination.

Query parameters:

| Parameter  | Type   | Default | Max | Description                                      |
| ---------- | ------ | ------- | --- | ------------------------------------------------ |
| category | string | —       | —   | Filter by category code (e.g. cloudcomputing) |
| search   | string | —       | —   | Full-text search on service name                 |
| cursor   | string | —       | —   | Opaque cursor from a previous response           |
| limit    | number | 50      | 100 | Number of results per page                       |

Pass pagination.nextCursor from a response as the cursor on your next request to page through results. Keep going while pagination.hasMore is true.

Response 200:

Example:

Get a Service

GET /api/v2/services/{slug}

Get the current status of a single service and all its components.

Path parameter: slug — the service's URL slug (e.g. github).

Response 200:

Returns 400 badrequest if the slug is missing or invalid, and 404 notfound if the service does not exist.

Example:

List Monitors

GET /api/v2/monitors

List all monitors belonging to the authenticated workspace.

Response 200:

Each monitor carries a type describing its kind and an isCustom flag:

| type    | isCustom | Meaning                                                |
| --------- | :--------: | ------------------------------------------------------ |
| catalog |  false   | A monitor on a Statusfield catalog (3rd-party) service |
| http    |   true   | Your custom URL / server-response (uptime) monitor     |
| ssl     |   true   | Your custom SSL-certificate-expiry monitor             |
| domain  |   true   | Your custom domain-registration-expiry monitor         |
| custom  |   true   | A custom monitor with no more specific kind            |

expiresAt is the upcoming expiry date (ISO 8601) for ssl / domain monitors, and null for all other types.

Query parameters:

| Parameter | Type   | Default | Description                                                                             |
| --------- | ------ | ------- | --------------------------------------------------------------------------------------- |
| filter  | string | —       | outages returns only monitors whose component is currently in a non-operational state |

Example:

List Outages

GET /api/v2/outages

List every catalog service currently experiencing an outage or degradation — across all of Statusfield, not just your monitors.

Query parameters:

| Parameter | Type   | Default | Max | Description                 |
| --------- | ------ | ------- | --- | --------------------------- |
| limit   | number | 100     | 200 | Number of outages to return |

Response 200:

A non-operational service is anything not in OPERATIONAL, REROUTED, or PARTIALLYREROUTED. Custom (workspace-private) monitors are never included. The list is a bounded snapshot — there is no pagination.

Example:

Using the Same Key from AI Tools

Your sf key also works with the Statusfield MCP server, so AI tools like Claude can query live status directly. See the MCP Server guide to connect it.

For the current per-plan request and quota limits, see Pricing.

Query the live status of thousands of services over a read-only REST API. Bearer-authenticated JSON, available on the Hobby plan and up.

API Reference

Statusfield helps you monitor the uptime and availability of critical online services. Get instant notifications when your monitored services experience issues.

<CardGroup cols={2}>
  <Card
    icon='🚀'
    title='Quick Start'
    description='Get up and running with Statusfield in minutes'
    href='/docs/quickstart'
  />
  <Card
    icon='🔌'
    title='Integrations'
    description='Connect with Slack, email, webhooks, and more'
    href='/docs/integrations'
  />
</CardGroup>

Key Features

- Real-time Monitoring: Track <ServiceCount /> services across major providers
- Smart Notifications: Get alerted via Email, Slack, Discord, or Webhooks
- Status History: View detailed incident timelines and component status
  {/ - API Access: Programmatic access to service status data /}

<Callout variant='info' title='Free Plan Available'>
  Start monitoring for free. No credit card required.
</Callout>

What You Can Monitor

Statusfield tracks services from major providers including:

- Cloud providers (AWS, Google Cloud, Azure)
- Developer tools (GitHub, GitLab, Vercel)
- Communication platforms (Slack, Discord, Zoom)
- And <ServiceCount /> more services

Getting Help

Need assistance? We're here to help:

- Check out our Quick Start Guide
- Explore Integrations
- Contact support via the in-app chat

Learn how to use Statusfield to monitor your critical services and get notified when things go wrong.

Documentation

Get instant notifications in your Discord channels when monitored services experience issues. Color-coded embeds make it easy to spot the severity at a glance.

<Callout variant='info' title='Paid Plan Required'>
  Discord notifications are available on the Hobby, Startup, and Pro plans.
  Upgrade your plan to get started.
</Callout>

Quick Start

<Steps>
  <Step title="Create a Discord Webhook">
    In your Discord server:
    1. Right-click the channel where you want notifications
    2. Select Edit Channel
    3. Go to Integrations > Webhooks
    4. Click New Webhook
    5. Name it "Statusfield" (optional)
    6. Click Copy Webhook URL

    <Callout variant="info" title="Permissions">
    You need Manage Webhooks permission in the Discord channel to create a webhook.
    </Callout>

  </Step>

  <Step title="Add Webhook to Statusfield">
    1. Go to statusfield.com/integrations
    2. Click the Discord card
    3. Click Add Discord Integration
    4. Enter a name (e.g., "#incidents", "DevOps Alerts")
    5. Paste the Discord webhook URL
    6. Click Add Discord

  </Step>

  <Step title="Test It Out">
    1. Click the menu (⋮) next to your Discord integration
    2. Select Test Notification
    3. Check that the test message appears in your Discord channel

  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Configure when you want to receive notifications (status by column)
      - On any status change
      - On maintenance status
      - On degraded status
      - On major outage status
      - On partial outage status

    All statuses will notify you when the component went back to operational status.

  </Step>

</Steps>

Discord Message Format

Notifications appear as rich embeds in your Discord channel with color-coded borders:

- 🟢 Green — Operational
- 🟡 Yellow — Degraded
- 🟠 Orange — Partial Outage
- 🔴 Red — Major Outage
- ⚪ Gray — Maintenance

Each embed includes:

- Title — Service name and status change (e.g., "GitHub — Status Changed")
- Description — What changed (e.g., "API Requests is now Degraded")
- Current Status — The new status
- Previous Status — What the status was before the change
- Affected Components — List of impacted components (if applicable)
- Timestamp — When the change occurred
- Link — Click the embed title to view the service on Statusfield

Managing Discord Integrations

Add Multiple Channels

You can add multiple Discord webhooks (up to your plan limit) for:

- Different Discord servers
- Separate channels for different severity levels
- Team-specific alert channels

Each Discord integration can be configured independently for different services and notification levels.

Edit or Remove

1. Open statusfield.com/integrations > Discord
2. Click the menu (⋮) next to the integration
3. Select Edit to update the name or webhook URL
4. Select Delete to remove the integration

<Callout variant='warning' title='Warning'>
  Deleting a Discord integration removes all associated notification rules. This
  cannot be undone.
</Callout>

Troubleshooting

<Callout variant="warning" title="Not Receiving Discord Notifications?">
Common issues and solutions:

1. Webhook Was Deleted in Discord

- If someone deletes the webhook in Discord settings, notifications will fail silently
- Create a new webhook in Discord and update the URL in Statusfield

2. Channel Was Deleted or Archived

- Discord webhooks stop working if the target channel is removed
- Create a new webhook in an active channel

3. Webhook URL Is Invalid

- Discord webhook URLs must match the format: https://discord.com/api/webhooks/...
- Make sure you copied the full URL from Discord

4. Rate Limits

- Discord has rate limits on webhook messages
- If you're monitoring many services with frequent status changes, some messages may be delayed

</Callout>

Security & Privacy

- Webhook URLs are encrypted in our database
- All communication with Discord uses HTTPS
- We only send messages — we never read your Discord messages, channels, or user data
- No Discord bot is installed in your server

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Send service status notifications to your Discord channels

Discord

Email is the primary notification method for Statusfield. Receive instant, reliable alerts when your monitored services experience issues, directly to your inbox.

<Callout variant='success' title='Default Email Address'>
  Your sign up email address is automatically added as an email address for
  notifications and used as your default email address for notifications for
  each new monitor you add. You can change the monitor's notification channels
  in statusfield.com/notifications
</Callout>

Quick Start

<Steps>
  <Step title="Add an Email Address">
    1. Go to statusfield.com/integrations
    2. Click the Email card
    3. Click Add Email Address
    4. Enter a name (e.g., "Personal", "Team Lead") and email address
    5. Click Add Email
  </Step>

  <Step title="Verify Your Email">
    Check your inbox for a verification email from noreply@send.statusfield.com. Click the verification link to activate notifications.

    <Callout variant="warning" title="Verification Required">
    Email notifications won't be sent until you verify your email address. The verification link expires after 24 hours.
    </Callout>

  </Step>

  <Step title="Test Your Setup">
    1. Click the menu (⋮) next to your email integration
    2. Select Test Email
    3. Check that the test message appears in your email inbox

  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Configure when you want to receive notifications (status by column)
      - On any status change
      - On maintenance status
      - On degraded status
      - On major outage status
      - On partial outage status

    All statuses will notify you when the component went back to operational status.

  </Step>

</Steps>

Email Contents

Each notification email includes:

- Subject line - Service name and current status (e.g., "GitHub - Partial Outage")
- Service details - Which service and components are affected
- Status information - Current status with severity level
- Affected components - Complete list of impacted components
- Link - Button linking to full incident details on Statusfield

Managing Email Addresses

Add Multiple Emails

You can add multiple email addresses (up to your plan limit) for:

- Personal backup addresses
- Team distribution (e.g., "DevOps Team", "On-Call Engineer")
- Different departments
- External stakeholders

Each email can be configured independently for different services and notification levels.

<Callout variant='warning' title='Note'>
  Your default email (account email) cannot be edited or removed from
  integrations.
</Callout>

Troubleshooting Delivery

<Callout variant="warning" title="Not Receiving Emails?">
Common issues and solutions:

1. Check Spam Folder

- Look for emails from @send.statusfield.com
- Mark as "Not Spam" and add to safe senders

2. Verify Email Status

- Go to statusfield.com/integrations > Email
- Look for "Pending" badge > click (⋮) > Resend Verification

3. Corporate Email Filters

- Some organizations may delay delivery due to spam filters. Wait a few minutes and check your spam/junk folder.
- Some organizations (especially with Mimecast, Proofpoint) block automated emails
- Contact your IT department to whitelist send.statusfield.com
- Try adding a personal email (Gmail, Outlook) as backup

4. Email Forwarding Rules

- Check if you have filters that auto-archive or delete automated emails
- Ensure Statusfield emails aren't being automatically filtered

5. Inbox Full

- If your mailbox is full, you won't receive new emails
- Clear space and try sending a test email

</Callout>

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Emails

Statusfield integrates with your existing workflow to deliver notifications where you need them. Choose from multiple notification channels and combine them for comprehensive coverage.

Available Integrations

<CardGroup cols={2}>
  <Card
    title='Email Notifications'
    description='Receive instant email alerts when services go down'
    href='/docs/integrations/email'
  />
  <Card
    title='Slack'
    description='Get notifications in your Slack channels'
    href='/docs/integrations/slack'
  />
  <Card
    title='Discord'
    description='Send notifications to your Discord channels'
    href='/docs/integrations/discord'
  />
  <Card
    title='Webhooks'
    description='Send custom HTTP requests when status changes'
    href='/docs/integrations/webhooks'
  />
  <Card
    title='PagerDuty'
    description='Trigger and auto-resolve incidents in your on-call rotation'
    href='/docs/integrations/pagerduty'
  />
  <Card
    title='Telegram'
    description='Get alerts in a Telegram chat or group'
    href='/docs/integrations/telegram'
  />
  <Card
    title='RSS Feeds'
    description='Subscribe to status changes via RSS or Atom'
    href='/docs/integrations/rss'
  />
  <Card
    title='API Access'
    description='Read-only REST API for programmatic access to service status'
    href='/docs/api'
  />
  <Card
    title='MCP Server'
    description='Hosted MCP server for Claude and other AI assistants'
    href='/docs/mcp'
  />
  <Card
    title='n8n'
    description='Trigger n8n workflows when service status changes'
    href='/docs/integrations/n8n'
  />
</CardGroup>

Multiple Notification Channels

You can enable multiple integrations simultaneously. For example:

- Email for critical alerts
- Slack for team visibility
- Webhooks for automation

<Callout variant='info' title='Smart Notifications'>
  Statusfield only sends notifications when service status changes, preventing
  alert fatigue from duplicate notifications.
</Callout>

Integration Features

All integrations support:

- Real-time delivery - Notifications sent within seconds
- Status updates - Get notified when issues are resolved
- Component details - See which specific components are affected

Advanced Automation with Webhooks

Webhooks open up powerful automation possibilities:

- Integrate with custom tools and internal systems
- Trigger automation workflows via Zapier, Make, or n8n
- Build custom dashboards with real-time status data
- Connect to ITSM platforms like PagerDuty or ServiceNow

Learn more about webhooks →

Connect Statusfield with your favorite tools and services

Integrations

Connect Statusfield to n8n using a webhook trigger. When a monitored service goes down, degrades, or recovers, Statusfield fires an HTTP POST to your n8n workflow — no npm package or coding required.

<Callout variant='info' title='Paid Plan Required'>
  Webhook notifications are available on the Hobby, Startup, and Pro plans.
  Upgrade your plan to get started.
</Callout>

Quick Start

<Steps>
  <Step title="Create a Webhook trigger in n8n">
    In your n8n workspace:
    1. Click New Workflow
    2. Add a Webhook node as the trigger
    3. Set HTTP Method to POST
    4. Set Response Mode to Respond Immediately
    5. Click Listen for Test Event to activate the URL
    6. Copy the Webhook URL shown in the node

    <Callout variant="info" title="Production URL">
      n8n shows a Test URL and a Production URL. Use the Test URL while setting up,
      then switch to the Production URL once your workflow is working.
    </Callout>
  </Step>

  <Step title="Add a Webhook integration in Statusfield">
    1. Go to statusfield.com/integrations
    2. Click the Webhooks card
    3. Click Add Webhook
    4. Enter a name (e.g., "n8n — incident workflow")
    5. Paste the n8n Webhook URL
    6. Leave method as POST
    7. Click Add Webhook
  </Step>

  <Step title="Test the connection">
    1. Click the menu (⋮) next to your webhook integration
    2. Select Test Notification
    3. In n8n, check that the test event arrived in your Webhook node

    The payload will look like:

    
  </Step>

  <Step title="Build your workflow">
    With the payload arriving, add nodes after the Webhook trigger to do whatever you need:

    - Send a Slack message — pass service and status into a Slack node
    - Create a Jira ticket — open an incident when status is majoroutage
    - Page on-call — call an OpsGenie or PagerDuty node
    - Log to a spreadsheet — write every status change to Google Sheets

    When you're done, click Activate to switch to the Production URL.
  </Step>

  <Step title="Configure notification rules">
    1. Go to statusfield.com/notifications
    2. Find the service you want to trigger your workflow
    3. Enable notifications for the statuses that matter to you
  </Step>
</Steps>

Payload Reference

Statusfield sends a JSON body on every status change:

| Field | Type | Description |
|---|---|---|
| service | string | Human-readable service name (e.g., "GitHub") |
| serviceSlug | string | URL slug (e.g., "github") |
| component | string | Affected component name |
| status | string | New status: operational, degraded, partialoutage, majoroutage, maintenance |
| previousStatus | string | Status before this change |
| timestamp | string | ISO 8601 UTC timestamp |
| url | string | Statusfield page for this service |

Tips

Filter by severity in n8n — Add an If node after the Webhook trigger to branch on status:
- Route majoroutage to a PagerDuty call
- Route degraded to a Slack message
- Route operational (recovery) to close the incident

Use the Production URL — The Test URL in n8n only works when the workflow is open and in test mode. Switch to the Production URL before saving your Statusfield webhook.

Troubleshooting

<Callout variant="warning" title="Not receiving events in n8n?">

1. Test URL vs Production URL

The Test URL only accepts events while the workflow editor is open with "Listen for Test Event" active. For live events, activate the workflow and use the Production URL.

2. Workflow is not active

In n8n, check the toggle in the top-right of the workflow editor. The workflow must be Active to receive production events.

3. Webhook URL changed

If you re-create the Webhook node in n8n, the URL changes. Update the URL in statusfield.com/integrations.

</Callout>

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Trigger n8n workflows when monitored services change status

Route Statusfield alerts straight into your PagerDuty on-call rotation. When a monitored service degrades, Statusfield opens a PagerDuty incident; when it recovers, the incident resolves itself automatically — no manual clean-up.

<Callout variant='info' title='Plan Availability'>
  PagerDuty is available on higher-tier plans. See the pricing
  page for current availability, or open the PagerDuty card on
  your integrations page to check
  whether it's included in your plan.
</Callout>

How It Works

Statusfield uses PagerDuty's Events API V2. Each monitored service maps to a single PagerDuty incident:

- Degradation triggers an incident — the incident summary names the service and its new status.
- Recovery resolves it automatically — when the service returns to Operational, Statusfield resolves the same incident.
- One incident per service — if several components of the same service change, they update the existing incident instead of paging you again for each one.
- Severity is derived from status — outages map to higher PagerDuty severities (critical / error), lesser issues to warning.

<Callout variant='info' title='No Alert Fatigue'>
  Because incidents are keyed per service, a flapping service won't spam your
  on-call. You get one incident that stays open until the service actually
  recovers.
</Callout>

Quick Start

<Steps>
  <Step title="Create an Events API V2 Integration in PagerDuty">
    In your PagerDuty account:
    1. Open the Service you want alerts on (or create one)
    2. Go to the Integrations tab → Add integration
    3. Choose Events API V2
    4. Copy the generated Integration Key (also called the routing key) — it's a 32-character string

    <Callout variant='info' title='Where the incident lands'>
      The PagerDuty Service you attach the integration to determines which
      escalation policy and on-call schedule handle the alert. Pick the Service
      whose responders should react to this outage.
    </Callout>
  </Step>

  <Step title="Add the Integration to Statusfield">
    1. Go to statusfield.com/integrations
    2. Click the PagerDuty card
    3. Give it a Name (e.g., "On-call escalation")
    4. Paste your Routing Key (Integration Key)
    5. Click Create
  </Step>

  <Step title="Test It Out">
    1. Click the menu (⋮) next to your PagerDuty integration
    2. Select Test Notification
    3. A test incident appears in PagerDuty and then resolves itself moments later — confirming the routing key works end to end
  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Choose which status changes should page you (any change, degraded, partial outage, major outage, maintenance)

    Every configured status also resolves the incident when the component returns to Operational.
  </Step>
</Steps>

Incident Format

Each PagerDuty incident Statusfield opens includes:

- Summary — the service name and its new status (e.g., "GitHub: Major Outage")
- Source — statusfield.com
- Severity — mapped from the service status (critical, error, warning, or info)
- Dedup key — scoped to the service, so updates and the recovery land on the same incident

Troubleshooting

<Callout variant='warning' title='Not Receiving PagerDuty Incidents?'>
  Common issues and solutions:

1. Invalid routing key

- The routing key must be the Integration Key from an Events API V2
  integration (32 characters). Keys from other integration types won't work.
- Re-copy the key from PagerDuty and update the integration in Statusfield.

2. Incident opened but nobody was paged

- Check the escalation policy on the PagerDuty Service you attached the
  integration to — the on-call schedule there controls who gets notified.

3. Incident didn't resolve

- Resolution fires when the service returns to Operational. A service that
  stays degraded keeps its incident open by design.

</Callout>

Security & Privacy

- Routing keys are stored encrypted in our database.
- Statusfield only sends incident triggers and resolves — it never reads your
  PagerDuty incidents, schedules, or user data.
- All PagerDuty API calls use HTTPS.

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Trigger and auto-resolve PagerDuty incidents when monitored services go down

PagerDuty

Prefer to pull status updates instead of receiving pushed alerts? Statusfield publishes RSS and Atom feeds you can subscribe to in any feed reader, or wire into tools like Slack, Zapier, or a status dashboard.

There are two kinds of feed:

<CardGroup cols={2}>
  <Card
    title='Per-Service Status Feed'
    description='Public feed of status changes for a single service'
  />
  <Card
    title='Your Monitors Feed'
    description='One feed covering every service you monitor'
  />
</CardGroup>

Per-Service Status Feed

Every public service page has its own feed of status changes — no account or key required. It mirrors the last 7 days of the public service page.

- Swap .rss for .atom if your reader prefers Atom.
- Add ?format=slack for Slack-friendly formatting (see below).

<Callout variant='info' title='Finding the URL'>
  Open any service page on Statusfield and use its RSS link, or just append
  /feed.rss to the service URL.
</Callout>

Your Monitors Feed

Get a single feed covering all the services you monitor, so you don't have to subscribe to each one individually.

- Swap .rss for .atom for an Atom feed.
- Add ?format=slack for Slack-friendly formatting.
- The key is your workspace RSS Key — copy it (and the ready-made feed URL) from Settings → RSS at statusfield.com/settings?tab=rss.

<Callout variant='warning' title='Keep Your Feed Key Private'>
  Anyone with your feed URL can see the list of services you monitor and their
  status history. Treat the key like a password and don't post the URL
  publicly.
</Callout>

<Callout variant='info' title='History Window'>
  How far back the monitors feed reaches depends on your plan. See the pricing
  page for details. The per-service public feed always covers the
  last 7 days.
</Callout>

Slack-Friendly Formatting

Both feeds accept ?format=slack, which formats each entry so it renders cleanly when piped into Slack (for example via Slack's /feed subscribe or an automation tool):

What's in a Feed Entry

Each entry represents a status change and includes:

- Title — the service (or component) name and its new status, with a status emoji
- Description — affected components and a link back to the incident on Statusfield
- Timestamp — when the change was detected
- Stable identifiers — entries keep a stable ID across polls, so your reader won't re-flag old changes as unread

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Get instant notifications in your Slack workspace when monitored services experience issues. Perfect for keeping your team informed in real-time with collaborative incident response.

Overview

Statusfield supports two types of Slack integration:

1. OAuth Channels (Recommended) - Connect your Slack workspace and select channels from a list
2. Incoming Webhooks - Use Slack webhook URLs for simple one-way notifications

<Callout variant='info' title='Which Method Should I Use?'>
  OAuth is recommended for most users - it's easier to set up, more
  reliable, and allows you to pick channels from a list. Use webhooks only if
  you need to send notifications to external Slack workspaces you don't control.
</Callout>

Quick Start: OAuth Channels

<Steps>
  <Step title="Connect Your Slack Workspace">
    1. Go to statusfield.com/integrations
    2. Click the Slack card
    3. Click Connect Slack button
    4. Select your Slack workspace
    5. Click Allow to grant Statusfield permissions

    <Callout variant="info" title="Permissions">
    Statusfield requests permission to:
    - View channel names and topics
    - Post messages to channels you select
    - No access to message history or DMs
    </Callout>

  </Step>

  <Step title="Add a Channel">
    After connecting:
    1. Click Add Slack Integration button in the manage drawer
    2. Select "Add Channel" option
    3. Select desired channel from the list
    4. Click Add Channel button
    5. You can edit the channel name later in the manage drawer

    You can add multiple channels and configure each one independently.

  </Step>

  <Step title="Test It Out">
    1. Click the menu (⋮) next to your Slack integration
    2. Select Test Notification
    3. Check that the test message appears in your Slack channel

  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Configure when you want to receive notifications (status by column)
      - On any status change
      - On maintenance status
      - On degraded status
      - On major outage status
      - On partial outage status

    All statuses will notify you when the component went back to operational status.

  </Step>

</Steps>

Quick Start: Slack Webhooks

<Steps>
  <Step title="Create a Slack Webhook">
    In your Slack workspace:
    1. Go to https://api.slack.com/apps
    2. Click Create New App > From scratch
    3. Name it "Statusfield" and select your workspace
    4. Navigate to Slack Features > Incoming Webhooks and toggle it on
    5. Click Add New Webhook
    6. Select the channel
    7. Copy the webhook URL (starts with https://hooks.slack.com/...)
  </Step>

  <Step title="Add Webhook to Statusfield">
    1. Go to statusfield.com/integrations
    2. Click the Slack card
    3. Click Add Slack Integration button
    4. Select "Slack Webhook" option
    5. Enter a name (e.g., "#engineering-alerts")
    6. Paste the webhook URL
    7. Click Add Webhook button

  </Step>

  <Step title="Test It Out">
    1. Click the menu (⋮) next to your Slack integration
    2. Select Test Notification
    3. Check that the test message appears in your Slack channel

  </Step>

</Steps>

Slack Message Format

Each Slack notification includes:

- Service name - Clear identification (e.g., "🔴 GitHub")
- Status level - Current status with emoji indicator
  - 🟢 Operational
  - 🟡 Degraded
  - 🟠 Partial Outage
  - 🔴 Major Outage
  - 🔵 Maintenance
- Affected components - List of impacted components
- Timestamp - When the incident started
- Link - Button linking to full incident details on Statusfield

Managing OAuth Connections

View Connected Workspace

In the Slack integrations drawer, you'll see:

- Connected workspace name (e.g., "Connected to Acme Corp workspace")

Disconnect Workspace

To disconnect your Slack workspace:

1. Open statusfield.com/integrations > Slack
2. Click Disconnect next to the connected workspace
3. Confirm the action

<Callout variant='warning' title='Warning'>
  Disconnecting removes all OAuth channels and their notification rules.
  Everything is deleted. Webhooks are not affected.
</Callout>

Reconnect After Disconnection

If you disconnected or revoked access:

1. Click Connect Slack again
2. Authorize the workspace
3. Re-add your channels

Your previous notification configuration won't be restored automatically.

Troubleshooting

<Callout variant="warning" title="Not Receiving Slack Notifications?">
  Common issues and solutions:

1. OAuth Connection Expired

- Go to statusfield.com/integrations > Slack
- Click Connect Slack button
- Reauthorize the workspace

</Callout>

Security & Privacy

Permissions

Statusfield's Slack app requests minimal permissions:

- channels:read - View public channel names
- groups:read - View private channel names (if invited)
- chat:write - Post messages to selected channels
- chat:write.public - Post to public channels without invitation

We never access:

- Message history or content
- Direct messages
- User information
- Files or attachments

Data Protection

- OAuth tokens are encrypted in our database
- Tokens are only used to post notifications, nothing else
- Webhook URLs are stored securely
- All Slack API calls use HTTPS

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Receive service status notifications in your Slack workspace

Slack

Receive instant status alerts in a personal Telegram chat or a shared group. Statusfield connects through its own Telegram bot — there's nothing to self-host and no bot token to manage.

<Callout variant='info' title='Plan Availability'>
  Telegram is available on paid plans. See the pricing page for
  current availability, or open the Telegram card on your integrations
  page to check whether it's included in
  your plan.
</Callout>

Quick Start

<Steps>
  <Step title="Add a Telegram Integration">
    1. Go to statusfield.com/integrations
    2. Click the Telegram card
    3. Give it a Name (e.g., "Ops group")
    4. Click Continue
  </Step>

  <Step title="Connect Your Chat or Group">
    Choose where alerts should go:

    - Connect personal chat — opens the Statusfield bot in your own Telegram DM
    - Connect a group — lets you pick a group to add the bot to

    Tap the button, then tap Start (for a group, confirm adding the bot). Statusfield links the chat automatically.

    <Callout variant='warning' title='The link expires in 15 minutes'>
      The connect link is valid for 15 minutes. If it lapses before you tap
      Start, reopen the integration and start the connect step again.
    </Callout>
  </Step>

  <Step title="Confirm the Connection">
    Once you tap Start, the integration flips to Connected and names the
    chat it linked (e.g., "Connected to Ops group"). You're done.
  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Choose which status changes should notify you (any change, degraded, partial outage, major outage, maintenance)

    Every configured status also notifies you when the component returns to Operational.
  </Step>
</Steps>

<Callout variant='info' title='Changing the Chat'>
  Each Telegram integration is linked to one chat. To deliver alerts to a
  different chat or group, remove the integration and add a new one.
</Callout>

Message Format

Each Telegram message includes:

- Service name and a status emoji (🟢 Operational, 🟡 Degraded, 🟠 Partial Outage, 🔴 Major Outage, 🔵 Maintenance)
- Affected components — the specific components impacted
- Timestamp — when the change was detected
- Link — a link to full incident details on Statusfield

Troubleshooting

<Callout variant='warning' title='Not Receiving Telegram Messages?'>
  Common issues and solutions:

1. The connect link expired

- The link is valid for 15 minutes. Reopen the Telegram integration and restart
  the connect step to get a fresh link.

2. Group members aren't seeing alerts

- Make sure the bot was actually added to the group when you tapped Start.
  If the group's privacy settings blocked it, remove and re-add the integration.

3. You want alerts somewhere else

- Integrations are one-chat-per-connection. Add a separate Telegram integration
  for each chat or group you want to notify.

</Callout>

Security & Privacy

- Statusfield only sends messages to the chat you explicitly connect.
- The bot never reads your chat history — it only receives the /start command that links the chat.
- The link code is single-use and short-lived (15 minutes).

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Get service status notifications in a Telegram chat or group

Webhooks let you send HTTP requests to any endpoint when a monitored service changes status. Use them to trigger automations, update dashboards, create tickets, or integrate with any tool that accepts HTTP requests.

<Callout variant='info' title='Paid Plan Required'>
  Webhooks are available on the Hobby, Startup, and Pro plans. Upgrade your
  plan to get started.
</Callout>

Quick Start

<Steps>
  <Step title="Add a Webhook">
    1. Go to statusfield.com/integrations
    2. Click the Webhooks card
    3. Click Add Webhook
    4. Enter a name (e.g., "PagerDuty", "Jira Automation")
    5. Enter the webhook URL (must be HTTPS)
    6. Select the HTTP method (POST, GET, PUT, PATCH, or DELETE)
    7. Optionally configure authentication and custom headers
    8. Click Add Webhook

    <Callout variant="warning" title="HTTPS Required">
    Webhook URLs must use HTTPS. HTTP URLs are not accepted for security reasons.
    </Callout>

  </Step>

  <Step title="Configure Authentication (Optional)">
    If your endpoint requires authentication, select one:

    - None — No authentication header sent
    - Bearer Token — Sends Authorization: Bearer <your-token> header
    - Basic Auth — Sends Authorization: Basic <your-credentials> header

    Your authentication credentials are encrypted and stored securely.

  </Step>

  <Step title="Add Custom Headers (Optional)">
    You can add custom HTTP headers in JSON format:

    

  </Step>

  <Step title="Test It Out">
    1. Click the menu (⋮) next to your webhook integration
    2. Select Test Webhook
    3. Verify that your endpoint received the test request

  </Step>

  <Step title="Configure Notifications">
    When adding a monitor for a service:
    1. Go to statusfield.com/notifications
    2. Find the service in the list
    3. Configure when you want to receive notifications (status by column)
      - On any status change
      - On maintenance status
      - On degraded status
      - On major outage status
      - On partial outage status

    All statuses will notify you when the component went back to operational status.

  </Step>

</Steps>

Webhook Payload

When a status change occurs, Statusfield sends a JSON payload to your endpoint. Here's the full structure:

Payload Fields

| Field                    | Description                                                            |
| ------------------------ | ---------------------------------------------------------------------- |
| id                     | Unique delivery identifier                                             |
| event                  | Always "statuschange"                                               |
| level                  | "service" for top-level changes, "component" for component changes |
| service                | Service name, slug, and last check time                                |
| component              | Affected component with current and previous status                    |
| affectedComponents     | Array of child components that changed                                 |
| statusChange.direction | "worsening", "improving", or "unchanged"                         |
| statusChange.timestamp | ISO 8601 timestamp of the change                                       |
| url                    | Link to the service page on Statusfield                                |

Status Codes

| Status Code      | Human-Readable |
| ---------------- | -------------- |
| OPERATIONAL    | Operational    |
| DEGRADED       | Degraded       |
| PARTIALOUTAGE | Partial Outage |
| MAJOR_OUTAGE   | Major Outage   |
| MAINTENANCE    | Maintenance    |
| UNKNOWN        | Unknown        |

HTTP Methods

Choose the HTTP method that matches your endpoint:

- POST (default) — Standard for webhook receivers. Payload sent as JSON body.
- PUT — Payload sent as JSON body.
- PATCH — Payload sent as JSON body.
- GET — No request body sent. Use for simple ping-style endpoints.
- DELETE — No request body sent.

<Callout variant='info' title='Content-Type'>
  For POST, PUT, and PATCH requests, the payload is sent as application/json.
</Callout>

Delivery & Retries

- Notifications are sent within seconds of a status change
- Failed deliveries are retried up to 3 times with increasing delays
- Your endpoint should respond with a 2xx status code to confirm receipt
- Requests time out after 10 seconds
- HTTP redirects are not followed for security reasons

Use Cases

Webhooks are flexible enough for many integrations:

- Incident management — Create tickets in PagerDuty, Opsgenie, or ServiceNow
- Project management — Post to Jira, Linear, or Asana when services go down
- Custom dashboards — Feed status data into Grafana or Datadog
- Automation — Trigger Zapier, Make, or n8n workflows
- Internal tools — Update your own systems with real-time status data
- Chat tools — Send to Microsoft Teams, Telegram, or any chat with an incoming webhook

Managing Webhooks

Edit or Remove

1. Open statusfield.com/integrations > Webhooks
2. Click the menu (⋮) next to the integration
3. Select Edit to update the URL, method, authentication, or headers
4. Select Delete to remove the integration

<Callout variant='warning' title='Warning'>
  Deleting a webhook integration removes all associated notification rules. This
  cannot be undone.
</Callout>

Troubleshooting

<Callout variant="warning" title="Not Receiving Webhook Notifications?">
Common issues and solutions:

1. Endpoint Returns Non-2xx Status

- Your endpoint must return a 2xx status code (e.g., 200, 201, 204)
- Check your server logs for errors
- Verify the endpoint is accessible from the internet

2. HTTPS Certificate Issues

- Ensure your SSL certificate is valid and not expired
- Self-signed certificates may cause delivery failures

3. Authentication Errors

- Verify your Bearer token or Basic Auth credentials are correct
- Check that the authentication method matches what your endpoint expects

4. Timeout

- Webhook requests time out after 10 seconds
- Make sure your endpoint responds quickly — process the payload asynchronously if needed

5. Firewall or IP Restrictions

- Ensure your endpoint accepts requests from external sources
- Webhook requests originate from Cloudflare's IP ranges

</Callout>

Security

- All webhook URLs must use HTTPS
- Authentication credentials are encrypted in our database
- Custom headers are encrypted in our database
- HTTP redirects are rejected to prevent URL hijacking
- Each delivery has a unique id for deduplication

<Callout variant='info' title='Need Help?'>
  Contact our support team at
  support@statusfield.com
</Callout>

Send custom HTTP requests when service status changes

Webhooks

The Model Context Protocol (MCP) is an open standard for connecting AI assistants to external tools and live data. Statusfield hosts a read-only MCP server that exposes the same status catalog as the REST API, so you can ask Claude (or any MCP-capable client) questions like "Is GitHub having issues right now?" and get answers straight from live data.

Requirements

The MCP server uses the same sf API key as the REST API — no separate credential. Create one at Settings → Integrations → API Keys, where you can also revoke it later. The key is shown only once at creation time.

<Callout variant='info' title='Hobby plan and up'>
  MCP access is available on the Hobby, Pro, and Team plans — the same gate
  as the REST API. It is not available on the Free plan. A Free-plan key
  returns 403 planrestriction. See
  /pricing for per-plan limits.
</Callout>

Connecting

The server speaks Streamable HTTP at POST /api/mcp and authenticates with your sf key in the Authorization header.

<Steps>
  <Step title="Get an API key">
    Go to Settings → Integrations → API Keys at
    statusfield.com/integrations and
    create a key. Copy it — it is shown only once.
  </Step>

  <Step title="Add it to the Claude Code CLI">
    Run the following, replacing sf<your-key> with your key:

    

  </Step>

  <Step title="Or add it to Claude Desktop">
    Add this block to your claudedesktopconfig.json:

    

  </Step>

  <Step title="Ask a question">
    Once connected, ask your assistant something like "Is GitHub having any
    issues right now?" and it will call the matching tool automatically.
  </Step>
</Steps>

Tools

The server exposes four read-only tools:

| Tool                    | Input           | Description                                                                 |
| ----------------------- | --------------- | --------------------------------------------------------------------------- |
| searchservices       | query: string | Search the catalog by name; returns up to 10 matches as Name (slug) lines |
| getservicestatus    | slug: string  | Current status of a service and all its components                          |
| listoutages          | (none)        | All services currently experiencing an outage or degradation                |
| listmydownservices | (none)        | Your own monitored services currently down or degraded                      |

<Callout variant='warning' title='Catalog tools vs. your monitors'>
  searchservices, getservicestatus, and listoutages operate on
  Statusfield's public catalog — you look services up by name or slug.
  listmydownservices is the exception: it reads your workspace's own
  monitors and reports which are currently down or degraded. For your full
  monitor list (healthy ones included), use the REST endpoint GET
  /api/v2/monitors instead (see the API reference).
</Callout>

Rate limits & quota

- Rate limit: your plan's per-workspace burst limit applies to every request. X-RateLimit-Limit and X-RateLimit-Remaining are returned on responses, and a Retry-After (seconds) header is added on 429.
- Monthly quota: only tools/call invocations count toward your plan's monthly request quota. Protocol traffic (initialize, tools/list) is free. X-Quota-* headers are returned on metered requests, and exceeding the cap returns 429 quotaexceeded. The counter resets at the start of each UTC month.

See /pricing for the per-plan request and quota limits.

Example prompts

Natural-language questions map onto the tools automatically:

- "Is GitHub having any issues right now?" → getservicestatus with slug github
- "What services are currently down?" → listoutages
- "Is anything I monitor down right now?" → listmydownservices
- "Find monitoring services" → searchservices with query monitoring

Next steps

- API reference — the full REST API, including GET /api/v2/monitors for your own workspace's monitors.
- Pricing — per-plan rate limits and monthly quotas.

Connect Claude and other AI tools to Statusfield's live status catalog with the hosted MCP server. Read-only, Hobby plan and up.

MCP Server

Get up and running with Statusfield in under 5 minutes. This guide will walk you through creating your account, adding your first monitor, and setting up notifications.

Prerequisites

All you need is an email address or a GitHub/Google account to get started.

<Steps>
  <Step title="Create Your Account">
    Visit statusfield.com/sign-up and sign up using one of the following methods:
    - Email (magic link)
    - GitHub OAuth
    - Google OAuth

    No credit card required.

  </Step>

  <Step title="Add Your First Monitor">
    Once logged in:
    1. Visit statusfield.com/services
    2. Search for a service (e.g., "GitHub", "AWS")
    3. Select the service you want to monitor
    4. Click "Monitor" in the top right corner of the service page
  </Step>
</Steps>

- You'll now receive alerts when the service is experiencing issues to the email address you used to sign up.
- You can also add additional email addresses to your account to share alerts with your team or use other notification methods like Slack or Webhooks.
- You can add more integrations in the statusfield.com/integrations page and manage how you receive alerts in statusfield.com/notifications.

<Callout variant='success' title="You're All Set!">
  You're now monitoring critical services. Statusfield will notify you
  immediately when issues are detected.
</Callout>

Understanding Status Levels

Statusfield tracks five status levels:

- Operational - Service is working normally
- Degraded - Service is slow or experiencing minor issues
- Partial Outage - Some components are down
- Major Outage - Significant service disruption
- Maintenance - Scheduled maintenance

Upgrading Your Plan

Ready for more monitors? Check out our plans:

<PlansInfo />

Visit your settings page to upgrade your plan.

Get started with Statusfield in just a few minutes