IncidentIo.FollowUpsV2 (IncidentIo v0.3.1)

View Source

Manage follow-up actions from incidents.

Follow-ups are actions identified during an incident that should be completed after the incident is resolved. They can be filtered by incident and mode.

Summary

Functions

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

Create a follow-up for an incident.

list(client \\ %Client{}, incident_id \\ nil, incident_mode \\ nil)

List all follow-ups for an organisation.

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

Get a single incident follow-up.

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

Update an existing follow-up.

Functions

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

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

Create a follow-up for an incident.

Example

IncidentIo.FollowUpsV2.create(client, %{
  description: "Call the fire brigade",
  incident_id: "01FCNDV6P870EA6S7TK1DSYDG0",
  status: "outstanding",
  title: "Cat is stuck in the tree"
})

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

list(client \\ %Client{}, incident_id \\ nil, incident_mode \\ nil)

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

List all follow-ups for an organisation.

Example

IncidentIo.FollowUpsV2.list(client)

IncidentIo.FollowUpsV2.list(client, "some-incident-id")

IncidentIo.FollowUpsV2.list(client, "some-incident-id", :retrospective)

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

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

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

Get a single incident follow-up.

Example

IncidentIo.FollowUpsV2.show(client, "some-follow-up-id")

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

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

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

Update an existing follow-up.

Example

IncidentIo.FollowUpsV2.update(client, "some-follow-up-id", %{status: "completed"})

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