View Source Runbox.Scenario.OutputAction.Incident (runbox v22.0.0)

This module is deprecated. This output action is deprecated, use V2.Incident instead.

Parameters for output action Incident.

The resulting output action creates an incident.

Summary

Types

severity()

t()

Incident

user_actions()

User actions that can be fired on the incident.

Types

severity()

@type severity() :: 1..4

t()

@type t() :: %Runbox.Scenario.OutputAction.Incident{
  actors: [Runbox.Scenario.OutputAction.IncidentActor.t()] | nil,
  additional_attributes: map() | nil,
  future: [Runbox.Scenario.OutputAction.IncidentFuture.t()],
  history: [Runbox.Scenario.OutputAction.IncidentHistory.t()],
  id: String.t(),
  resolved: boolean(),
  severity: severity(),
  status: String.t(),
  subject: Runbox.Scenario.OutputAction.interpolable(),
  type: String.t(),
  user_actions: user_actions() | nil
}

Incident

user_actions()

@type user_actions() :: %{optional(key :: String) => Joken.bearer_token()}

User actions that can be fired on the incident.

The value of a user action is a JWT obtained by calling Runbox.Scenario.UserAction.pack/3.

Each user action has a key by which it can later be referenced in Runbox.Scenario.OutputAction.IncidentPatch and either modified or deleted.

Example

{:ok, action} = UserAction.pack("cam_actions", "close_incident", %{...})
%{"close" => action}