IncidentIo.AlertsV2 (IncidentIo v0.3.1)

Manage alerts within incident.io.

Alerts are notifications from monitoring systems that can trigger incidents. This is distinct from IncidentIo.AlertEventsV2 which handles inbound webhook alert events from HTTP sources.

Summary

Functions

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

Create a new alert.

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

List all alerts for an organisation.

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

Get a single alert.

Functions

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

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

Create a new alert.

Example

IncidentIo.AlertsV2.create(client, %{
  title: "High error rate on api.example.com",
  status: "firing"
})

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

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

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

List all alerts for an organisation.

Accepts optional pagination parameters:

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

Example

IncidentIo.AlertsV2.list(client)

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

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

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

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

Get a single alert.

Example

IncidentIo.AlertsV2.show(client, "some-alert-id")

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