IncidentResource

Create an incident

Create a new incident in an authorized team. Subject to creation rate limits.

Required API key permissions

  • Scope: incidents:create
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
  • Organization role (user-linked keys only): Member when the user has an explicit organization membership. Explicit organization membership is not required; team-based access applies and effective access is gated by the required team role.
  • Required team role (user-linked keys only): Member
  • Organization API keys are not subject to organization or team role checks.
  • Notes: Target teams must belong to the resolved organization. Subject to creation rate limits.
post/api/public/v1/incident

Request

Query parameters

organizationIdstring uuid

Request body

titlestring required
messagestring nullable
messageIsPublicboolean nullable
integrationIdstring uuid nullable
teamIdsstring[] nullable
statusstring required
severitystring required
serviceIdsstring[] nullable
excludeFromUptimeCalculationboolean nullable
statusPageStartOverridestring date-time nullable
statusPageEndOverridestring date-time nullable
publicCommentstring nullable

Response

OK

idstring uuid required
titlestring nullable required
createdAtstring date-time nullable required
lastUpdatedAtstring date-time required
eventsTotalCountinteger required
unattendedboolean required
isArchivedboolean required
allowedIntentsstring[] nullable required
canDeleteboolean nullable
excludeFromUptimeCalculationboolean
statusPageStartOverridestring date-time nullable
statusPageEndOverridestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.