Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

Before you can invite teammates or start managing incidents, you need to set up your business profile and configure your incident management system (IMS). This page walks you through the full onboarding flow — from registering your business account to adding your first team members.

​
Onboarding flow

1

Register your account

Create a Scrubbe account at app.scrubbe.com. During registration, select BUSINESS as your account type to unlock team management and IMS features.
If you select DEVELOPER as your account type, you will not have access to team invitations or IMS configuration. You can upgrade your account type at any time from your account settings.
2

Set up your business profile

Call the business setup endpoint to register your organization’s details. Replace the placeholder values with your actual business information.
PUT /api/v1/business/setup

{
  "businessName": "Acme Corp",
  "industry": "Technology",
  "size": "51-200"
}
3

Configure your IMS

Set up your incident management system to control how Scrubbe handles alerts, notifications, and escalations for your team.
POST /api/v1/ims/setup
Request body
{
  "alertEmail": "oncall@acme.com",
  "slackChannel": "#incidents",
  "slaEnabled": true,
  "autoEscalate": true,
  "notifyOnCreate": true,
  "notifyOnResolve": true,
  "timezone": "America/New_York"
}
FieldTypeDescription
alertEmailstringEmail address that receives incident alert notifications.
slackChannelstringSlack channel name where incident notifications are posted.
slaEnabledbooleanEnable SLA tracking for incidents.
autoEscalatebooleanAutomatically escalate incidents that breach SLA thresholds.
notifyOnCreatebooleanSend notifications when a new incident is created.
notifyOnResolvebooleanSend notifications when an incident is resolved.
timezonestringIANA timezone used for SLA calculations and timestamps.
Once your IMS is set up, you can update any of these fields at any time:
PUT /api/v1/ims/config
To review your current IMS configuration:
GET /api/v1/ims/config
4

Invite team members

Send an invitation to each teammate you want to add to your organization. You assign their role and access permissions at the time of invitation.
POST /api/v1/business/send-invite
Request body
{
  "email": "teammate@example.com",
  "role": "ENGINEER",
  "accessPermissions": ["incidents", "postmortems"],
  "level": "Senior"
}
The role field controls what actions the teammate can perform across Scrubbe. The available roles are:
RoleDescription
SUPER_ADMINFull access to all settings, billing, and team management.
ADMINManage team members and configure IMS settings.
MANAGEROversee incident workflows and assign responders.
ENGINEERCreate and manage incidents.
RESPONDERRespond to assigned incidents.
VIEWERRead-only access to incidents and reports.
Use accessPermissions to restrict which resources the teammate can see, even within their role. For example, an ENGINEER can be limited to only ["incidents"] if you do not want them accessing postmortem data.
5

Teammate accepts the invitation

When your teammate receives the invitation email, they need to decode the invite token and then accept it.Decode the invite token:
POST /api/v1/business/decode-invite
Request body
{
  "token": "INVITE_TOKEN_FROM_EMAIL"
}
Accept the invitation:
POST /api/v1/business/accept-invite
Request body
{
  "token": "INVITE_TOKEN_FROM_EMAIL"
}
Once accepted, the teammate’s account is linked to your organization and they can log in with the role and permissions you assigned.

​
View your team members

To see a list of all members currently in your organization, including their roles and access levels: 
GET /api/v1/business/get_members
cURL
curl --request GET \
  --url https://api.scrubbe.com/api/v1/business/get_members \
  --header 'Authorization: Bearer YOUR_TOKEN'
Only users with the ADMIN or SUPER_ADMIN role can view the full member list or send new invitations.

​
Next steps

API keys

Create and manage API keys to authenticate requests to the Scrubbe API.

Billing

Review your plan and manage your subscription.