Jido.Messaging.IngressOutcome (Jido Messaging v1.0.0)

Copy Markdown View Source

Canonical normalized ingress result for webhook and non-webhook payload paths.

Summary

Functions

Builds an ingress outcome from attrs.

Returns the Zoi schema.

Types

t()

@type t() :: %Jido.Messaging.IngressOutcome{
  bridge_id: binary(),
  context: nil | nil | any(),
  envelope:
    nil
    | nil
    | %Jido.Chat.EventEnvelope{
        adapter_name: term(),
        channel_id: term(),
        event_type: term(),
        id: term(),
        message_id: term(),
        metadata: term(),
        payload: term(),
        raw: term(),
        thread_id: term()
      },
  error: nil | nil | any(),
  message: nil | nil | any(),
  mode: atom(),
  response:
    nil
    | nil
    | %Jido.Chat.WebhookResponse{
        body: term(),
        headers: term(),
        metadata: term(),
        status: term()
      },
  status: atom()
}

Functions

new(attrs)

@spec new(map()) :: t()

Builds an ingress outcome from attrs.

schema()

Returns the Zoi schema.