Skip to main content
Manage post-mortem documents. Post-mortem documents capture the learnings from an incident, and are associated with a specific incident. Use this API to list and retrieve post-mortem documents, update their status, and fetch the full document’s content.

​
The postmortemdocument object

​
created_at
string<date-time>
required

Timestamp for when the document was created

Example:

"2021-08-17T13:28:57.801578Z"

​
document_url
string
required

A URL to view the post-mortem document in the incident.io dashboard

Example:

"https://app.incident.io/my-org/incidents/123/post-mortems/01GDZEW57FDA1K4S63MGMQ5DS9"

​
editors
object[]
required

The list of users who have edited this post-mortem document

Example:
​
exported_urls
string[]
required

URLs of any external locations this document has been exported to

Example:
​
id
string
required

Unique identifier for the post-mortem document

Example:

"01GDZEW57FDA1K4S63MGMQ5DS9"

​
incident_id
string
required

The unique identifier of the incident that this post-mortem document belongs to

Example:

"01GBA8J19SMXQWPJMX3P2ESCVG"

​
status
enum<string>
required

The current status of this post-mortem document

Available options:
in_progress,
in_review,
completed
Example:

"in_progress"

​
title
string
required

The display title of the post-mortem document

Example:

"INC-123: Database is sad"

​
type
enum<string>
required

Whether this is a native incident.io post-mortem or one hosted in an external provider

Available options:
in_app,
external
Example:

"in_app"

​
updated_at
string
required

Timestamp for when the document was last updated

Example:

"abc123"