IncidentIo.IncidentsV1 (IncidentIo v0.3.1)

View Source

Create and read incidents.

Incidents are a core resource, on which many other resources (actions, etc) are created.

Care should be taken around these endpoints, as automation that creates duplicate incidents can be distracting, and impact reporting.

Summary

Functions

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

Create a new incident.

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

List all incidents for an organisation.

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

Get a single incident.

Functions

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

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

Create a new incident.

incident body example:

%{
  category: "live",
  description: "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  name: "Closed"
}

Example

IncidentIo.IncidentsV1.create(client, body)

More information at: https://api-docs.incident.io/tag/Incidents-V1#operation/Incidents%20V1_Create

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

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

List all incidents for an organisation.

Example

IncidentIo.IncidentsV1.list(client)

More information at: https://api-docs.incident.io/tag/Incidents-V1#operation/Incidents%20V1_List

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

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

Get a single incident.

Example

IncidentIo.IncidentsV1.show(client, "some-incident-id")

More information at: https://api-docs.incident.io/tag/Incidents-V1#operation/Incidents%20V1_Show