IncidentIo.EscalationPathsV2 (IncidentIo v0.3.1)

Manage escalation paths for your organisation.

Escalation paths define how alerts and incidents are escalated through your team, specifying who gets notified and when if an incident goes unacknowledged.

Summary

Functions

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

Create a new escalation path.

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

Delete an escalation path.

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

List all escalation paths for an organisation.

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

Get a single escalation path.

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

Update an existing escalation path.

Functions

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

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

Create a new escalation path.

Example

IncidentIo.EscalationPathsV2.create(client, %{name: "Default Escalation Path"})

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

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

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

Delete an escalation path.

Example

IncidentIo.EscalationPathsV2.destroy(client, "some-escalation-path-id")

More information at: https://api-docs.incident.io/tag/Escalation-Paths-V2#operation/Escalation%20Paths%20V2_Delete

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

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

List all escalation paths for an organisation.

Accepts optional pagination parameters:

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

Example

IncidentIo.EscalationPathsV2.list(client)

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

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

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

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

Get a single escalation path.

Example

IncidentIo.EscalationPathsV2.show(client, "some-escalation-path-id")

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

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

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

Update an existing escalation path.

Example

IncidentIo.EscalationPathsV2.update(client, "some-escalation-path-id", %{
  name: "Updated Escalation Path"
})

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