IncidentIo.PostMortemsV2 (IncidentIo v0.3.1)

Manage post-mortems for incidents.

Post-mortems document lessons learned and follow-up actions after an incident is resolved. They help teams improve their processes and prevent recurrence.

Summary

Functions

create(client \\ %Client{}, body)

Create a new post-mortem.

list(client \\ %Client{}, opts \\ [])

List all post-mortems for an organisation.

show(client \\ %Client{}, id)

Get a single post-mortem.

update(client \\ %Client{}, id, body)

Update an existing post-mortem.

Functions

create(client \\ %Client{}, body)

@spec create(IncidentIo.Client.t(), map()) :: IncidentIo.response()

Create a new post-mortem.

Example

IncidentIo.PostMortemsV2.create(client, %{
  incident_id: "01FCNDV6P870EA6S7TK1DSYDG0",
  name: "Incident post-mortem"
})

More information at: https://api-docs.incident.io/tag/Post-Mortems-V2#operation/Post%20Mortems%20V2_Create

list(client \\ %Client{}, opts \\ [])

@spec list(
  IncidentIo.Client.t(),
  keyword()
) :: IncidentIo.response()

List all post-mortems for an organisation.

Accepts optional pagination parameters:

:after - Cursor for pagination
:page_size - Number of items per page (default: 25, max: 250)

Example

IncidentIo.PostMortemsV2.list(client)

IncidentIo.PostMortemsV2.list(client, page_size: 50)

More information at: https://api-docs.incident.io/tag/Post-Mortems-V2#operation/Post%20Mortems%20V2_List

show(client \\ %Client{}, id)

@spec show(IncidentIo.Client.t(), binary()) :: IncidentIo.response()

Get a single post-mortem.

Example

IncidentIo.PostMortemsV2.show(client, "some-post-mortem-id")

More information at: https://api-docs.incident.io/tag/Post-Mortems-V2#operation/Post%20Mortems%20V2_Show

update(client \\ %Client{}, id, body)

@spec update(IncidentIo.Client.t(), binary(), map()) :: IncidentIo.response()

Update an existing post-mortem.

Example

IncidentIo.PostMortemsV2.update(client, "some-post-mortem-id", %{
  name: "Updated post-mortem"
})

More information at: https://api-docs.incident.io/tag/Post-Mortems-V2#operation/Post%20Mortems%20V2_Update