View Source IncidentIo.IncidentsV1 (IncidentIo v0.1.0)

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 \\ %{page_size: nil, after: nil, status: nil})

List all incidents for an organisation.

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

Get a single incident.

Functions

Link to this function

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

View Source 
@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

Link to this function

list(client \\ %Client{}, opts \\ %{page_size: nil, after: nil, status: nil})

View Source 
@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

Link to this function

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

View Source 
@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