Atlassian Statuspage Documentation: Setup, API, Incidents
When your platform coordinates patient transportation, home care scheduling, and DME delivery, every minute of downtime directly affects patient outcomes. That's exactly why teams managing healthcare logistics infrastructure, including ours at VectorCare, rely on tools like Atlassian Statuspage to keep stakeholders informed about system availability and performance. But getting the most out of Statuspage starts with understanding the Atlassian Statuspage documentation thoroughly, from initial setup to API integration and incident management.
Statuspage serves as the communication bridge between your operations team and everyone who depends on your platform, whether that's hospital administrators, dispatchers, or care coordinators. Configuring it correctly means your users get real-time status updates instead of flooding your support channels with "is it down?" calls. For organizations in healthcare logistics, where coordination between EHR systems, CAD platforms, and billing tools must run smoothly, a well-configured status page isn't optional, it's operational hygiene.
This guide walks you through the complete Statuspage setup process, covers the API endpoints you'll need for automation, and explains how to create and manage incidents effectively. Whether you're standing up Statuspage for the first time or looking to tighten your existing configuration, you'll find step-by-step instructions and practical context to get it done right.
How to navigate Statuspage docs and key concepts
The Atlassian Statuspage documentation lives at support.atlassian.com under the Statuspage product section. Atlassian organizes the docs into distinct categories covering getting started, feature-specific configuration, the REST API reference, and integration walkthroughs. Before you change a single setting inside Statuspage, spend ten minutes reading through the getting started section. Teams that skip this step frequently misconfigure components, misunderstand how subscriber notifications work, or build API integrations that break because they missed a key concept in the reference material.
Building a clear mental model of Statuspage's core terminology before setup will save you hours of rework and support tickets down the line.
Core Statuspage terminology you need to understand
Statuspage uses precise terms that mean specific things inside the platform. Confusing them causes configuration errors that are hard to diagnose after the fact, particularly when you're managing incident communications across multiple teams. The table below maps the key terms to plain-language definitions so you can move through this guide without stopping to look things up.
| Term | What it means in Statuspage |
|---|---|
| Page | Your public or private status site, the top-level container for all configuration |
| Component | An individual service or system element you track, such as "API" or "Database" |
| Component group | A logical grouping of related components displayed together on your page |
| Incident | An unplanned service disruption you communicate to subscribers in real time |
| Scheduled maintenance | A planned outage or degradation window you announce to users in advance |
| Metric | A real-time data point, like response time or uptime percentage, shown on your page |
| Subscriber | Any user who signs up for status notifications via email, SMS, webhook, or RSS |
How Atlassian organizes the help center
The Statuspage help center breaks into sections based on task type and user goal. The getting started section covers page creation and foundational configuration. Feature guides go deeper on each major capability: components, incidents, metrics, and subscriber management. The API reference documents every endpoint, parameter, authentication method, and response schema you need to automate updates. Integration documentation covers built-in connections to monitoring and alerting platforms.
For most teams, the right reading order is getting started first, then the feature guides for components and incidents, and finally the API reference once you're ready to automate status updates. Jumping straight to the API without understanding how Statuspage models incidents and components in its data structure leads to integrations that are fragile and hard to maintain.
What the API reference covers and how to use it
The Statuspage REST API uses standard HTTP methods (GET, POST, PUT, PATCH, DELETE) and returns JSON. Every resource in the platform, including pages, components, incidents, and subscribers, has a corresponding API endpoint. Atlassian publishes the full API reference at developer.statuspage.io, and each endpoint includes example requests, response schemas, error codes, and rate limit details.
Authentication uses an API key you generate inside your Statuspage account under Profile > API. You pass this key in the Authorization header of every request using the format OAuth YOUR_API_KEY. Never expose this key in client-side JavaScript or public repositories. For teams running healthcare logistics platforms where system availability directly affects patient care workflows, securing your API key and rotating it on a regular schedule is a basic operational requirement, not an afterthought.
Knowing where each piece of the documentation lives and what terminology Atlassian uses sets you up to move through the rest of the configuration steps quickly and without confusion.
Step 1. Pick a page type and access settings
When you first create a Statuspage account and click Create a page, Statuspage prompts you to choose your page type before you configure anything else. This is the most consequential early decision because it determines who can access your status page and how subscribers interact with it. Changing your page type after you've configured components and subscribers is not supported, so understand each option before you click through.
Choosing the wrong page type forces a full rebuild, so treat this decision as permanent from the start.
Public, private, and audience-specific page types
Statuspage offers three page types, and each serves a distinct use case. A public page is visible to anyone with the URL, requires no login, and works best for external-facing services where transparency with customers is the goal. A private page requires users to authenticate before viewing status, which suits internal tools or services where you don't want system information publicly indexed or accessible. The third option, audience-specific pages, lets you create segmented views so different subscriber groups only see the components that matter to them.
For healthcare logistics platforms coordinating transportation, home care, and DME delivery across multiple stakeholder groups, audience-specific pages often justify the added configuration effort. Hospital administrators don't need visibility into transport dispatch infrastructure, and DME vendors don't need to see your EHR integration health indicators.
| Page type | Who can view | Best use case |
|---|---|---|
| Public | Anyone with the URL | External customer-facing services |
| Private | Authenticated users only | Internal tools and staff-facing systems |
| Audience-specific | Defined subscriber segments | Multi-stakeholder platforms with segmented user bases |
How to set team access and permissions
Once you select your page type, navigate to Settings > Team inside your Statuspage account. From there, add team members and assign each one of three roles: Admin, Collaborator, or View Only. Admins have full control over configuration, incident creation, and API key management. Collaborators can create and update incidents but cannot change page-level settings. View Only users can monitor the dashboard but make no changes.
Limit Admin access to the people who directly own incident response. For most teams running infrastructure that supports patient logistics workflows covered in the Atlassian Statuspage documentation, that means one operations lead and one backup. Grant Collaborator access to dispatchers or coordinators who post incident updates during active events, which reduces the risk of accidental configuration changes under pressure.
Step 2. Configure page info, branding, and domains
With your page type selected, the next task is filling in your page name, URL slug, and timezone before you touch anything else. Navigate to Settings > Page Settings in the Statuspage dashboard. These settings form the metadata backbone of your status page and directly affect how subscribers identify your service and how notifications are labeled. Getting this right at the start prevents confusing communication later during an active incident.
Stakeholders read your page name in every notification email, so make it instantly recognizable to your users rather than using internal system names.
Set your page name, URL slug, and timezone
Your page name appears in every subscriber notification, so it should match what your users already call your service. If you run a patient logistics platform, use the product name your hospital administrators and dispatchers recognize, not an internal code name. Your URL slug determines your default Statuspage-hosted address (for example, yourorganization.statuspage.io), and you cannot change it easily later, so choose a slug that reflects your organization or product clearly.
Set your timezone to match your primary operations center. Statuspage timestamps every incident update and scheduled maintenance window in the timezone you configure here. For healthcare logistics teams covering multiple regions, choose the timezone where your incident response team sits so your own coordinators read timestamps without mental conversion.
Configure branding and appearance
Statuspage gives you direct control over logo, brand color, and custom CSS under Settings > Branding. Upload your logo as a PNG at the recommended size of 300x100 pixels for clean rendering across devices. Set your brand color using a hex value, which Statuspage applies to incident severity banners, buttons, and key UI elements.
The Atlassian Statuspage documentation notes that custom CSS is available on paid plans, letting you override default styles for teams with strict brand guidelines. Apply CSS changes conservatively. Statuspage updates its frontend periodically, and aggressive CSS overrides can break your page layout after a platform update.
Set up a custom domain
Pointing a custom domain at your Statuspage replaces the default statuspage.io URL with something like status.yourorganization.com. Add a CNAME record in your DNS provider pointing your chosen subdomain to hosting.statuspage.io, then enter the custom domain in Settings > Custom Domain. Statuspage handles SSL automatically once DNS propagates, which typically takes between 15 minutes and 48 hours depending on your DNS provider's TTL settings.
Step 3. Create components and component groups
Components are the building blocks of your status page. Each component represents a specific service or system element you want to monitor and communicate about publicly, such as your API, database, scheduling service, or notification pipeline. Navigate to Components in your Statuspage dashboard and click Add Component to start building your list. Getting your component structure right at this stage prevents confusion later when you're posting incident updates under time pressure.
Map your components to the services your users actually interact with, not to your internal infrastructure naming conventions.
How to add individual components
When you click Add Component, Statuspage presents a form asking for a component name, description, and initial status. Name each component using language your subscribers already recognize. If hospital administrators depend on your patient scheduling interface, call it "Scheduling" rather than "svc-scheduler-prod." The description field is optional but worth filling in. A single plain-language sentence tells new subscribers exactly what each component covers without requiring them to contact your support team.
Set the initial status to Operational when you first create a component. Statuspage gives you five status levels to assign to components during incidents or maintenance windows:
| Status | Meaning |
|---|---|
| Operational | The component is functioning normally |
| Degraded Performance | The component works but runs slower than expected |
| Partial Outage | Some users are affected |
| Major Outage | The component is unavailable for most or all users |
| Under Maintenance | A planned maintenance window is active |
Organize components into groups
Component groups let you cluster related components under a shared label on your public page. For example, you might group "API," "Authentication," and "Webhooks" under a label called "Platform Services." Grouping improves readability when your page carries more than five or six components, which is common for platforms coordinating multiple services across different stakeholder groups simultaneously.
To create a group, click Add Group in the Components section, give it a clear name, and drag existing components into it. The Atlassian Statuspage documentation advises keeping each group to a manageable size, typically between three and seven components, so your page stays scannable for subscribers who need answers fast during an active incident. Reorder both groups and individual components by dragging them into the sequence that reflects your service priority from your users' perspective, not your team's internal priority.
Step 4. Set up incident workflows and maintenance
Incidents and scheduled maintenance are where Statuspage earns its place in your operations stack. Navigate to Incidents in the left sidebar to start building your first incident. Statuspage separates these into two distinct categories: real-time incidents for unplanned disruptions and scheduled maintenance for planned downtime. Understanding how each one flows through your page keeps your stakeholders informed without creating notification fatigue.
Create and classify incidents
When you click Create Incident, Statuspage presents a form with five fields that shape every notification your subscribers receive. Fill in the incident name using plain, specific language your users understand, for example "API response delays affecting scheduling requests" rather than "svc-api degraded." Select the affected components from your existing component list, choose an impact level (Minor, Major, or Critical), write your initial update message, and set the incident status.
Statuspage uses four incident statuses to guide your communication from open to resolution:
| Incident status | When to use it |
|---|---|
| Investigating | You've confirmed a problem but don't know the cause yet |
| Identified | You've found the root cause and are working on a fix |
| Monitoring | The fix is deployed and you're watching for stability |
| Resolved | The incident is fully closed |
Post at least one update every 30 minutes during an active incident, even if you have nothing new to report. A brief "our team is still investigating and we'll update at [time]" message prevents subscriber frustration far more effectively than silence.
Regular updates during an incident, even without new findings, signal that your team is actively engaged and keeps subscribers from flooding your support channels.
Schedule and communicate maintenance windows
The Atlassian Statuspage documentation distinguishes maintenance windows from incidents because they follow a predictable notification timeline. To create one, click Schedule Maintenance under the Incidents menu and fill in the start time, expected end time, affected components, and a plain-language description of what work you're performing.
Statuspage sends automated notifications to subscribers at three points: when you create the window, one hour before it starts, and when it completes. Set your maintenance window at least 72 hours in advance for any work affecting patient logistics workflows so hospital administrators and dispatchers can adjust their own scheduling before the window opens. Avoid scheduling maintenance windows during peak care coordination hours by reviewing your platform's usage data first.
Step 5. Manage subscribers and notification channels
Subscribers are the people and systems that receive notifications whenever you create or update an incident or schedule maintenance. Navigate to Subscribers in the Statuspage dashboard to view your current list, manage existing subscriptions, and configure the notification channels your page supports. Setting this up correctly before your first incident means your stakeholders receive accurate, timely updates automatically instead of discovering problems through support tickets.
Understand subscriber types and notification channels
Statuspage supports four distinct subscription methods, and each one serves a different audience segment. Choose which channels to enable based on where your stakeholders actually pay attention, not which options are easiest to configure.
| Channel | How it works | Best for |
|---|---|---|
| Statuspage sends formatted emails at each incident update | Hospital administrators and care coordinators | |
| SMS | Text message alerts for each status change | Dispatchers who need instant mobile alerts |
| Webhook | HTTP POST requests to a URL you specify | Engineering teams and automated systems |
| RSS/Atom | Feed-based updates subscribers pull on their own schedule | Teams with existing feed aggregators |
Add and manage individual subscribers
You can add subscribers manually or allow users to subscribe directly from your public status page. To add someone manually, click Add Subscriber in the Subscribers section, choose the channel type, enter the contact details, and select which components the subscriber should receive notifications for. Giving subscribers component-level control keeps notification volume manageable and prevents stakeholders from unsubscribing because they're receiving updates about services that don't affect their workflows.
Letting subscribers choose their own components reduces unsubscribe rates and keeps the right people focused on the services they actually depend on.
Configure webhooks for automated notification routing
Webhook subscribers receive a structured JSON payload at the URL you specify whenever Statuspage fires a notification. To add one, click Add Subscriber, select Webhook, and enter your endpoint URL. Statuspage sends a POST request with the following payload structure for each incident update:
{
"meta": { "unsubscribe": "", "documentation": "" },
"page": { "id": "your_page_id", "status_indicator": "minor", "status_description": "Partial System Outage" },
"incident": {
"name": "API response delays",
"status": "investigating",
"impact": "minor",
"incident_updates": []
}
}
Validate your endpoint returns a 200 HTTP response within five seconds or Statuspage marks the delivery as failed. The Atlassian Statuspage documentation covers retry behavior and failure logging under the webhook reference section, which is worth reviewing before you put a webhook subscriber into production.
Step 6. Publish metrics and embed status in your app
Metrics give your subscribers a quantitative view of system health rather than a binary up-or-down status. Navigate to Metrics in your Statuspage dashboard and click Add Metric to start. Statuspage supports three data input methods: connecting directly to a monitoring provider, pulling data from a third-party source via their built-in integrations, or pushing custom data to your metric using the API. Choosing the right method depends on where your performance data already lives.
Add a metric source and connect data
Before Statuspage can display a metric, you need to point it at a data source and configure the display settings. When you click Add Metric, you'll see fields for metric name, suffix (for example "ms" for milliseconds), decimal places, and whether to display the metric as a line graph or a bar chart. Fill in these fields using labels your subscribers recognize: "API Response Time (ms)" communicates more clearly than "p95 latency."
Use metric names and units that match the language your stakeholders already use in their own reporting, not your internal monitoring tool's variable names.
If you're pushing custom data via the API, Statuspage provides a dedicated endpoint for this. Here's the basic request structure to submit a metric data point:
POST https://api.statuspage.io/v1/pages/{page_id}/metrics/{metric_id}/data.json
Headers:
Authorization: OAuth YOUR_API_KEY
Content-Type: application/json
Body:
{
"data": {
"timestamp": 1716729600,
"value": 142.5
}
}
Send data points on a consistent interval, typically every 60 seconds, to produce a clean graph. The Atlassian Statuspage documentation covers the full metric data schema and acceptable timestamp ranges in the API reference.
Embed the status widget in your application
Statuspage generates a JavaScript embed snippet that renders your current status directly inside your own web application or help center. Find it under Settings > Embed Component in your dashboard. Paste the snippet wherever you want the widget to appear, typically in a footer, admin panel, or system health page.
<script>
var script = document.createElement('script');
script.src = 'https://[your-page-slug].statuspage.io/embed/script.js';
document.getElementsByTagName('head')[0].appendChild(script);
</script>
The widget automatically updates in real time as you post incident changes, so your users see current status without refreshing the page. Place it where your users already look when something feels slow rather than burying it in your navigation.
Step 7. Automate updates with integrations and the API
Manual incident posting works for small teams, but it breaks down fast when your monitoring tools detect problems faster than your on-call engineer can react. Statuspage solves this by letting you connect external monitoring services and use the REST API to push status changes programmatically, cutting the gap between detection and communication to near zero.
Connect built-in monitoring integrations
Statuspage ships with pre-built integrations for monitoring tools including PagerDuty, Datadog, Pingdom, and New Relic. To activate one, navigate to Integrations in your Statuspage dashboard, select your monitoring provider, and follow the OAuth or API key pairing steps the platform walks you through. Once connected, you map each monitor in your external tool to a specific Statuspage component. When your monitoring platform triggers an alert, Statuspage automatically updates the corresponding component status and notifies your subscribers without anyone touching the dashboard.
Connecting your existing monitoring tool to Statuspage eliminates the manual step that most teams drop first when an incident gets chaotic.
Review the Atlassian Statuspage documentation for your specific integration to confirm which alert states map to which Statuspage component statuses, since different monitoring tools use different severity labels that don't always translate directly.
Automate incident updates via the API
For custom workflows that go beyond the built-in integrations, the Statuspage REST API gives you full programmatic control over incidents and component statuses. Use the following request to create an incident automatically from your own alerting pipeline:
POST https://api.statuspage.io/v1/pages/{page_id}/incidents.json
Headers:
Authorization: OAuth YOUR_API_KEY
Content-Type: application/json
Body:
{
"incident": {
"name": "Elevated API error rate",
"status": "investigating",
"impact_override": "minor",
"body": "We are investigating elevated error rates affecting API requests.",
"component_ids": ["your_component_id"],
"components": {
"your_component_id": "partial_outage"
}
}
}
Send a PATCH request to the same endpoint with the incident ID in the URL path to post follow-up updates as your team works through the problem. Include the status field set to monitoring when you deploy a fix, then resolved once you've confirmed stability. Building this sequence into your incident response runbook means your status page stays current automatically, even during high-pressure incidents when manual updates are the first thing your team forgets.
Quick wrap-up
You now have a complete path through the Atlassian Statuspage documentation, from selecting your page type and configuring branding to building components, managing incidents, and automating updates through the API. Each step builds on the previous one, so if you followed this guide in order, your status page is ready to handle real incidents without scrambling for instructions mid-crisis.
The core principle behind a well-configured Statuspage is proactive communication. Your subscribers, whether hospital administrators, dispatchers, or care coordinators, should never have to guess whether your platform is running. When you post consistent, timely updates and connect your monitoring tools to automate status changes, you remove that uncertainty entirely and keep your support queue clear.
If you manage patient logistics workflows where platform uptime directly affects care coordination, take a look at how VectorCare handles end-to-end patient logistics with built-in operational transparency and real-time workflow management.









