events

type AirtimeTransferredEvent ¶ added in v0.48.0

type AirtimeTransferredEvent struct {
	BaseEvent

	Sender        urns.URN         `json:"sender"`
	Recipient     urns.URN         `json:"recipient"`
	Currency      string           `json:"currency"`
	DesiredAmount decimal.Decimal  `json:"desired_amount"`
	ActualAmount  decimal.Decimal  `json:"actual_amount"`
	HTTPLogs      []*flows.HTTPLog `json:"http_logs"`
}

AirtimeTransferredEvent events are created when airtime has been transferred to the contact.

{
  "type": "airtime_transferred",
  "created_on": "2006-01-02T15:04:05Z",
  "sender": "tel:4748",
  "recipient": "tel:+1242563637",
  "currency": "RWF",
  "desired_amount": 120,
  "actual_amount": 100,
  "http_logs": [
    {
      "url": "https://dvs-api.dtone.com/v1/sync/transactions",
      "status": "success",
      "request": "POST /v1/sync/transactions HTTP/1.1\r\n\r\n{}",
      "response": "HTTP/1.1 200 OK\r\n\r\n{}",
      "created_on": "2006-01-02T15:04:05Z",
      "elapsed_ms": 123
    }
  ]
}

@event airtime_transferred

func NewAirtimeTransferred(t *flows.AirtimeTransfer, httpLogs []*flows.HTTPLog) *AirtimeTransferredEvent

type BaseEvent ¶

type BaseEvent struct {
	Type_      string         `json:"type" validate:"required"`
	CreatedOn_ time.Time      `json:"created_on" validate:"required"`
	StepUUID_  flows.StepUUID `json:"step_uuid,omitempty" validate:"omitempty,uuid4"`
}

BaseEvent is the base of all event types

func NewBaseEvent(typeName string) BaseEvent

func (e *BaseEvent) CreatedOn() time.Time

func (e *BaseEvent) SetStepUUID(stepUUID flows.StepUUID)

func (e *BaseEvent) StepUUID() flows.StepUUID

func (e *BaseEvent) Type() string

type BroadcastCreatedEvent ¶ added in v0.5.0

type BroadcastCreatedEvent struct {
	BaseEvent

	Translations flows.BroadcastTranslations `json:"translations" validate:"min=1,dive"`
	BaseLanguage i18n.Language               `json:"base_language" validate:"required"`
	Groups       []*assets.GroupReference    `json:"groups,omitempty" validate:"dive"`
	Contacts     []*flows.ContactReference   `json:"contacts,omitempty" validate:"dive"`
	ContactQuery string                      `json:"contact_query,omitempty"`
	URNs         []urns.URN                  `json:"urns,omitempty" validate:"dive,urn"`
}

BroadcastCreatedEvent events are created when an action wants to send a message to other contacts.

{
  "type": "broadcast_created",
  "created_on": "2006-01-02T15:04:05Z",
  "translations": {
    "eng": {
      "text": "hi, what's up",
      "attachments": [],
      "quick_replies": ["All good", "Got 99 problems"]
    },
    "spa": {
      "text": "Que pasa",
      "attachments": [],
      "quick_replies": ["Todo bien", "Tengo 99 problemas"]
    }
  },
  "base_language": "eng",
  "urns": ["tel:+12065551212"],
  "contacts": [{"uuid": "0e06f977-cbb7-475f-9d0b-a0c4aaec7f6a", "name": "Bob"}]
}

@event broadcast_created

func NewBroadcastCreated(translations flows.BroadcastTranslations, baseLanguage i18n.Language, groups []*assets.GroupReference, contacts []*flows.ContactReference, contactQuery string, urns []urns.URN) *BroadcastCreatedEvent

type ClassifierCalledEvent ¶ added in v0.51.0

type ClassifierCalledEvent struct {
	BaseEvent

	Classifier *assets.ClassifierReference `json:"classifier" validate:"required"`
	HTTPLogs   []*flows.HTTPLog            `json:"http_logs"`
}

ClassifierCalledEvent events have been replaced by service_called.

type ContactFieldChangedEvent ¶ added in v0.5.0

type ContactFieldChangedEvent struct {
	BaseEvent

	Field *assets.FieldReference `json:"field" validate:"required"`
	Value *flows.Value           `json:"value"`
}

ContactFieldChangedEvent events are created when a custom field value of the contact has been changed. A null values indicates that the field value has been cleared.

{
  "type": "contact_field_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "field": {"key": "gender", "name": "Gender"},
  "value": {"text": "Male"}
}

@event contact_field_changed

func NewContactFieldChanged(field *flows.Field, value *flows.Value) *ContactFieldChangedEvent

type ContactGroupsChangedEvent ¶ added in v0.18.0

type ContactGroupsChangedEvent struct {
	BaseEvent

	GroupsAdded   []*assets.GroupReference `json:"groups_added,omitempty" validate:"omitempty,dive"`
	GroupsRemoved []*assets.GroupReference `json:"groups_removed,omitempty" validate:"omitempty,dive"`
}

ContactGroupsChangedEvent events are created when a contact is added or removed to/from one or more groups.

{
  "type": "contact_groups_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "groups_added": [{"uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d", "name": "Reporters"}],
  "groups_removed": [{"uuid": "1e1ce1e1-9288-4504-869e-022d1003c72a", "name": "Customers"}]
}

@event contact_groups_changed

func NewContactGroupsChanged(added []*flows.Group, removed []*flows.Group) *ContactGroupsChangedEvent

type ContactLanguageChangedEvent ¶ added in v0.10.0

type ContactLanguageChangedEvent struct {
	BaseEvent

	Language string `json:"language"`
}

ContactLanguageChangedEvent events are created when the language of the contact has been changed.

{
  "type": "contact_language_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "language": "eng"
}

@event contact_language_changed

func NewContactLanguageChanged(language i18n.Language) *ContactLanguageChangedEvent

type ContactNameChangedEvent ¶ added in v0.10.0

type ContactNameChangedEvent struct {
	BaseEvent

	Name string `json:"name"`
}

ContactNameChangedEvent events are created when the name of the contact has been changed.

{
  "type": "contact_name_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "name": "Bob Smith"
}

@event contact_name_changed

func NewContactNameChanged(name string) *ContactNameChangedEvent

type ContactRefreshedEvent ¶ added in v0.24.0

type ContactRefreshedEvent struct {
	BaseEvent

	Contact json.RawMessage `json:"contact"`
}

ContactRefreshedEvent events are generated when the resume has a contact with differences to the current session contact.

{
  "type": "contact_refreshed",
  "created_on": "2006-01-02T15:04:05Z",
  "contact": {
    "uuid": "0e06f977-cbb7-475f-9d0b-a0c4aaec7f6a",
    "name": "Bob",
    "urns": ["tel:+11231234567"]
  }
}

@event contact_refreshed

func NewContactRefreshed(contact *flows.Contact) *ContactRefreshedEvent

type ContactStatusChangedEvent ¶ added in v0.84.0

type ContactStatusChangedEvent struct {
	BaseEvent

	Status flows.ContactStatus `json:"status"`
}

ContactStatusChangedEvent events are created when the status of the contact has been changed.

{
  "type": "contact_timezone_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "status": "blocked"
}

@event contact_status_changed

func NewContactStatusChanged(status flows.ContactStatus) *ContactStatusChangedEvent

type ContactTimezoneChangedEvent ¶ added in v0.10.0

type ContactTimezoneChangedEvent struct {
	BaseEvent

	Timezone string `json:"timezone"`
}

ContactTimezoneChangedEvent events are created when the timezone of the contact has been changed.

{
  "type": "contact_timezone_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "timezone": "Africa/Kigali"
}

@event contact_timezone_changed

func NewContactTimezoneChanged(timezone *time.Location) *ContactTimezoneChangedEvent

type ContactURNsChangedEvent ¶ added in v0.23.0

type ContactURNsChangedEvent struct {
	BaseEvent

	URNs []urns.URN `json:"urns" validate:"dive,urn"`
}

ContactURNsChangedEvent events are created when a contact's URNs have changed.

{
  "type": "contact_urns_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "urns": [
    "tel:+12345678900",
    "twitter:bob"
  ]
}

@event contact_urns_changed

func NewContactURNsChanged(urns []urns.URN) *ContactURNsChangedEvent

type DialEndedEvent ¶ added in v0.112.0

type DialEndedEvent struct {
	BaseEvent

	Dial *flows.Dial `json:"dial" validate:"required"`
}

DialEndedEvent events are created when a session is resumed after waiting for a dial.

{
  "type": "dial_ended",
  "created_on": "2019-01-02T15:04:05Z",
  "dial": {
    "status": "answered",
    "duration": 10
  }
}

@event dial_ended

func NewDialEnded(dial *flows.Dial) *DialEndedEvent

type DialWaitEvent ¶ added in v0.112.0

type DialWaitEvent struct {
	BaseEvent

	URN              urns.URN `json:"urn" validate:"required,urn"`
	DialLimitSeconds int      `json:"dial_limit_seconds"`
	CallLimitSeconds int      `json:"call_limit_seconds"`

	// when this wait expires and the whole run can be expired
	ExpiresOn *time.Time `json:"expires_on,omitempty"`
}

DialWaitEvent events are created when a flow pauses waiting for an IVR dial to complete.

{
  "type": "dial_wait",
  "created_on": "2019-01-02T15:04:05Z",
  "urn": "tel:+593979123456",
  "dial_limit_seconds": 60,
  "call_limit_seconds": 120,
  "expires_on": "2022-02-02T13:27:30Z"
}

@event dial_wait

func NewDialWait(urn urns.URN, dialLimitSeconds, callLimitSeconds int, expiresOn *time.Time) *DialWaitEvent

type EmailCreatedEvent ¶ added in v0.5.0

type EmailCreatedEvent struct {
	BaseEvent

	Addresses []string `json:"addresses" validate:"required,min=1"`
	Subject   string   `json:"subject" validate:"required"`
	Body      string   `json:"body"`
}

EmailCreatedEvent is no longer used but old sessions might include these

type EmailSentEvent ¶ added in v0.61.0

type EmailSentEvent struct {
	BaseEvent

	To      []string `json:"to" validate:"required,min=1"`
	Subject string   `json:"subject" validate:"required"`
	Body    string   `json:"body"`
}

EmailSentEvent events are created when an action has sent an email.

{
  "type": "email_sent",
  "created_on": "2006-01-02T15:04:05Z",
  "to": ["foo@bar.com"],
  "subject": "Your activation token",
  "body": "Your activation token is AAFFKKEE"
}

@event email_sent

func NewEmailSent(to []string, subject string, body string) *EmailSentEvent

type EnvironmentRefreshedEvent ¶ added in v0.24.0

type EnvironmentRefreshedEvent struct {
	BaseEvent

	Environment json.RawMessage `json:"environment"`
}

EnvironmentRefreshedEvent events are sent by the caller to tell the engine to update the session environment.

{
  "type": "environment_refreshed",
  "created_on": "2006-01-02T15:04:05Z",
  "environment": {
    "date_format": "YYYY-MM-DD",
    "time_format": "hh:mm",
    "timezone": "Africa/Kigali",
    "allowed_languages": ["eng", "fra"]
  }
}

@event environment_refreshed

func NewEnvironmentRefreshed(env envs.Environment) *EnvironmentRefreshedEvent

type ErrorEvent ¶

type ErrorEvent struct {
	BaseEvent

	Text string `json:"text" validate:"required"`
}

ErrorEvent events are created when an error occurs during flow execution.

{
  "type": "error",
  "created_on": "2006-01-02T15:04:05Z",
  "text": "invalid date format: '12th of October'"
}

@event error

func NewDependencyError(ref assets.Reference) *ErrorEvent

func NewError(err error) *ErrorEvent

func NewErrorf(format string, a ...any) *ErrorEvent

type Exclusions ¶ added in v0.160.0

type Exclusions struct {
	InAFlow bool `json:"in_a_flow,omitempty"`
}

type Extraction ¶ added in v0.144.0

type Extraction string

const (
	ExtractionNone    Extraction = "none"    // no response or body was empty
	ExtractionValid   Extraction = "valid"   // body was valid JSON
	ExtractionCleaned Extraction = "cleaned" // body could be made into JSON with some cleaning
	ExtractionIgnored Extraction = "ignored" // body couldn't be made into JSON and was ignored
)

type FailureEvent ¶ added in v0.47.1

type FailureEvent struct {
	BaseEvent

	Text string `json:"text" validate:"required"`
}

FailureEvent events are created when an error occurs during flow execution which prevents continuation of the session.

{
  "type": "failure",
  "created_on": "2006-01-02T15:04:05Z",
  "text": "unable to read flow"
}

@event failure

func NewFailure(err error) *FailureEvent

type FlowEnteredEvent ¶

type FlowEnteredEvent struct {
	BaseEvent

	Flow          *assets.FlowReference `json:"flow" validate:"required"`
	ParentRunUUID flows.RunUUID         `json:"parent_run_uuid" validate:"omitempty,uuid4"`
	Terminal      bool                  `json:"terminal"`
}

FlowEnteredEvent events are created when an action has entered a sub-flow.

{
  "type": "flow_entered",
  "created_on": "2006-01-02T15:04:05Z",
  "flow": {"uuid": "0e06f977-cbb7-475f-9d0b-a0c4aaec7f6a", "name": "Registration"},
  "parent_run_uuid": "95eb96df-461b-4668-b168-727f8ceb13dd",
  "terminal": false
}

@event flow_entered

func NewFlowEntered(flow *assets.FlowReference, parentRunUUID flows.RunUUID, terminal bool) *FlowEnteredEvent

type IVRCreatedEvent ¶ added in v0.25.0

type IVRCreatedEvent struct {
	BaseEvent

	Msg *flows.MsgOut `json:"msg" validate:"required"`
}

IVRCreatedEvent events are created when an action wants to send an IVR response to the current contact.

{
  "type": "ivr_created",
  "created_on": "2006-01-02T15:04:05Z",
  "msg": {
    "uuid": "2d611e17-fb22-457f-b802-b8f7ec5cda5b",
    "channel": {"uuid": "61602f3e-f603-4c70-8a8f-c477505bf4bf", "name": "Twilio"},
    "urn": "tel:+12065551212",
    "text": "hi there",
    "attachments": ["audio:https://s3.amazon.com/mybucket/attachment.m4a"],
    "locale": "eng-US"
  }
}

@event ivr_created

func NewIVRCreated(msg *flows.MsgOut) *IVRCreatedEvent

type InputLabelsAddedEvent ¶ added in v0.5.0

type InputLabelsAddedEvent struct {
	BaseEvent

	InputUUID flows.InputUUID          `json:"input_uuid" validate:"required,uuid4"`
	Labels    []*assets.LabelReference `json:"labels" validate:"required,min=1,dive"`
}

InputLabelsAddedEvent events are created when an action wants to add labels to the current input.

{
  "type": "input_labels_added",
  "created_on": "2006-01-02T15:04:05Z",
  "input_uuid": "4aef4050-1895-4c80-999a-70368317a4f5",
  "labels": [{"uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d", "name": "Spam"}]
}

@event input_labels_added

func NewInputLabelsAdded(inputUUID flows.InputUUID, labels []*flows.Label) *InputLabelsAddedEvent

type MsgCreatedEvent ¶ added in v0.6.0

type MsgCreatedEvent struct {
	BaseEvent

	Msg *flows.MsgOut `json:"msg" validate:"required"`
}

MsgCreatedEvent events are created when an action wants to send a reply to the current contact.

{
  "type": "msg_created",
  "created_on": "2006-01-02T15:04:05Z",
  "msg": {
    "uuid": "2d611e17-fb22-457f-b802-b8f7ec5cda5b",
    "channel": {"uuid": "61602f3e-f603-4c70-8a8f-c477505bf4bf", "name": "Twilio"},
    "urn": "tel:+12065551212",
    "text": "hi there",
    "attachments": ["image/jpeg:https://s3.amazon.com/mybucket/attachment.jpg"]
  }
}

@event msg_created

func NewMsgCreated(msg *flows.MsgOut) *MsgCreatedEvent

type MsgReceivedEvent ¶

type MsgReceivedEvent struct {
	BaseEvent

	Msg flows.MsgIn `json:"msg" validate:"required"`
}

MsgReceivedEvent events are sent by the caller to tell the engine that a message was received from the contact and that it should try to resume the session.

{
  "type": "msg_received",
  "created_on": "2006-01-02T15:04:05Z",
  "msg": {
    "uuid": "2d611e17-fb22-457f-b802-b8f7ec5cda5b",
    "channel": {"uuid": "61602f3e-f603-4c70-8a8f-c477505bf4bf", "name": "Twilio"},
    "urn": "tel:+12065551212",
    "text": "hi there",
    "attachments": ["https://s3.amazon.com/mybucket/attachment.jpg"]
  }
}

@event msg_received

func NewMsgReceived(msg *flows.MsgIn) *MsgReceivedEvent

type MsgWaitEvent ¶

type MsgWaitEvent struct {
	BaseEvent

	// when this wait times out and we can proceed assuming router has a timeout category. This value is relative
	// because we want it to start counting when the last message is actually sent, which the engine can't know.
	TimeoutSeconds *int `json:"timeout_seconds,omitempty"`

	// When this wait expires and the whole run can be expired
	ExpiresOn *time.Time `json:"expires_on,omitempty"`

	Hint flows.Hint `json:"hint,omitempty"`
}

MsgWaitEvent events are created when a flow pauses waiting for a response from a contact. If a timeout is set, then the caller should resume the flow after the number of seconds in the timeout to resume it.

{
  "type": "msg_wait",
  "created_on": "2022-01-03T13:27:30Z",
  "timeout_seconds": 300,
  "expires_on": "2022-02-02T13:27:30Z",
  "hint": {
     "type": "image"
  }
}

@event msg_wait

func NewMsgWait(timeoutSeconds *int, expiresOn *time.Time, hint flows.Hint) *MsgWaitEvent

func (e *MsgWaitEvent) UnmarshalJSON(data []byte) error

type OptInRequestedEvent ¶ added in v0.195.3

type OptInRequestedEvent struct {
	BaseEvent

	OptIn   *assets.OptInReference   `json:"optin" validate:"required"`
	Channel *assets.ChannelReference `json:"channel" validate:"required"`
	URN     urns.URN                 `json:"urn" validate:"required"`
}

OptInRequestedEvent events are created when an action has created an optin to be sent.

{
  "type": "optin_requested",
  "created_on": "2006-01-02T15:04:05Z",
  "optin": {
    "uuid": "248be71d-78e9-4d71-a6c4-9981d369e5cb",
    "name": "Joke Of The Day"
  },
  "channel": {
    "uuid": "4bb288a0-7fca-4da1-abe8-59a593aff648",
    "name": "Facebook"
  },
  "urn": "tel:+12065551212"
}

@event optin_requested

func NewOptInRequested(optIn *flows.OptIn, ch *flows.Channel, urn urns.URN) *OptInRequestedEvent

type ResthookCalledEvent ¶ added in v0.10.20

type ResthookCalledEvent struct {
	BaseEvent

	Resthook string          `json:"resthook"`
	Payload  json.RawMessage `json:"payload"`
}

ResthookCalledEvent events are created when a resthook is called. The event contains the payload that will be sent to any subscribers of that resthook. Note that this event is created regardless of whether there any subscriberes for that resthook.

{
  "type": "resthook_called",
  "created_on": "2006-01-02T15:04:05Z",
  "resthook": "success",
  "payload": {
    "contact:":{
      "name":"Bob"
    }
  }
}

@event resthook_called

func NewResthookCalled(resthook string, payload json.RawMessage) *ResthookCalledEvent

type RunExpiredEvent ¶ added in v0.4.0

type RunExpiredEvent struct {
	BaseEvent

	RunUUID flows.RunUUID `json:"run_uuid"    validate:"required,uuid4"`
}

RunExpiredEvent events are sent by the caller to tell the engine that a run has expired.

{
  "type": "run_expired",
  "created_on": "2006-01-02T15:04:05Z",
  "run_uuid": "0e06f977-cbb7-475f-9d0b-a0c4aaec7f6a"
}

@event run_expired

func NewRunExpired(run flows.Run) *RunExpiredEvent

type RunResultChangedEvent ¶ added in v0.5.0

type RunResultChangedEvent struct {
	BaseEvent

	Name              string          `json:"name" validate:"required"`
	Value             string          `json:"value"`
	Category          string          `json:"category"`
	CategoryLocalized string          `json:"category_localized,omitempty"`
	Input             string          `json:"input,omitempty"`
	Extra             json.RawMessage `json:"extra,omitempty"`
}

RunResultChangedEvent events are created when a run result is saved. They contain not only the name, value and category of the result, but also the UUID of the node where the result was generated.

{
  "type": "run_result_changed",
  "created_on": "2006-01-02T15:04:05Z",
  "name": "Gender",
  "value": "m",
  "category": "Male",
  "category_localized": "Homme",
  "node_uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d",
  "input": "M"
}

@event run_result_changed

func NewRunResultChanged(result *flows.Result) *RunResultChangedEvent

type ServiceCalledEvent ¶ added in v0.85.0

type ServiceCalledEvent struct {
	BaseEvent

	Service    string                      `json:"service"`
	Classifier *assets.ClassifierReference `json:"classifier,omitempty"`
	HTTPLogs   []*flows.HTTPLog            `json:"http_logs"`
}

ServiceCalledEvent events are created when an engine service is called.

{
  "type": "service_called",
  "created_on": "2006-01-02T15:04:05Z",
  "service": "classifier",
  "classifier": {"uuid": "1c06c884-39dd-4ce4-ad9f-9a01cbe6c000", "name": "Booking"},
  "http_logs": [
    {
      "url": "https://api.wit.ai/message?v=20200513&q=hello",
      "status": "success",
      "request": "GET /message?v=20200513&q=hello HTTP/1.1",
      "response": "HTTP/1.1 200 OK\r\n\r\n{\"intents\":[]}",
      "created_on": "2006-01-02T15:04:05Z",
      "elapsed_ms": 123
    }
  ]
}

@event service_called

func NewClassifierCalled(classifier *assets.ClassifierReference, httpLogs []*flows.HTTPLog) *ServiceCalledEvent

type SessionTriggeredEvent ¶ added in v0.4.0

type SessionTriggeredEvent struct {
	BaseEvent

	Flow          *assets.FlowReference     `json:"flow" validate:"required"`
	Groups        []*assets.GroupReference  `json:"groups,omitempty" validate:"dive"`
	Contacts      []*flows.ContactReference `json:"contacts,omitempty" validate:"dive"`
	ContactQuery  string                    `json:"contact_query,omitempty"`
	Exclusions    Exclusions                `json:"exclusions"`
	CreateContact bool                      `json:"create_contact,omitempty"`
	URNs          []urns.URN                `json:"urns,omitempty" validate:"dive,urn"`
	RunSummary    json.RawMessage           `json:"run_summary"`
	History       *flows.SessionHistory     `json:"history"`
}

SessionTriggeredEvent events are created when an action wants to start other people in a flow.

{
  "type": "session_triggered",
  "created_on": "2006-01-02T15:04:05Z",
  "flow": {"uuid": "0e06f977-cbb7-475f-9d0b-a0c4aaec7f6a", "name": "Registration"},
  "groups": [
    {"uuid": "8f8e2cae-3c8d-4dce-9c4b-19514437e427", "name": "New contacts"}
  ],
  "run_summary": {
    "uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d",
    "flow": {"uuid": "93c554a1-b90d-4892-b029-a2a87dec9b87", "name": "Other Flow"},
    "contact": {
      "uuid": "c59b0033-e748-4240-9d4c-e85eb6800151",
      "name": "Bob",
      "fields": {"state": {"value": "Azuay", "created_on": "2000-01-01T00:00:00.000000000-00:00"}}
    },
    "results": {
      "age": {
        "name": "Age",
        "value": "33",
        "node_uuid": "cd2be8c4-59bc-453c-8777-dec9a80043b8",
        "created_on": "2000-01-01T00:00:00.000000000-00:00"
      }
    }
  },
  "history": {
    "parent_uuid": "55105da5-abb5-4690-b1f6-ec2e5762a561",
    "ancestors": 3,
    "ancestors_since_input": 1
  }
}

@event session_triggered

func NewSessionTriggered(flow *assets.FlowReference, groups []*assets.GroupReference, contacts []*flows.ContactReference, contactQuery string, exclusions Exclusions, createContact bool, urns []urns.URN, runSummary json.RawMessage, history *flows.SessionHistory) *SessionTriggeredEvent

type Ticket ¶ added in v0.122.0

type Ticket struct {
	UUID     flows.TicketUUID       `json:"uuid"                   validate:"required,uuid4"`
	Topic    *assets.TopicReference `json:"topic"                  validate:"omitempty"`
	Body     string                 `json:"body"`
	Assignee *assets.UserReference  `json:"assignee,omitempty"     validate:"omitempty"`
}

type TicketOpenedEvent ¶ added in v0.86.0

type TicketOpenedEvent struct {
	BaseEvent

	Ticket *Ticket `json:"ticket"`
}

TicketOpenedEvent events are created when a new ticket is opened.

{
  "type": "ticket_opened",
  "created_on": "2006-01-02T15:04:05Z",
  "ticket": {
    "uuid": "2e677ae6-9b57-423c-b022-7950503eef35",
    "topic": {
      "uuid": "add17edf-0b6e-4311-bcd7-a64b2a459157",
      "name": "Weather"
    },
    "body": "Where are my cookies?",
    "assignee": {"email": "bob@nyaruka.com", "name": "Bob"}
  }
}

@event ticket_opened

func NewTicketOpened(ticket *flows.Ticket) *TicketOpenedEvent

type WaitTimedOutEvent ¶ added in v0.9.10

type WaitTimedOutEvent struct {
	BaseEvent
}

WaitTimedOutEvent events are sent by the caller when a wait has timed out - i.e. they are sent instead of the item that the wait was waiting for.

{
  "type": "wait_timed_out",
  "created_on": "2006-01-02T15:04:05Z"
}

@event wait_timed_out

func NewWaitTimedOut() *WaitTimedOutEvent

type WarningEvent ¶ added in v0.202.0

type WarningEvent struct {
	BaseEvent

	Text string `json:"text" validate:"required"`
}

WarningEvent events are created for things like accessing deprecated context values.

{
  "type": "warning",
  "created_on": "2006-01-02T15:04:05Z",
  "text": "deprecated context value accessed: legacy_extra"
}

@event warning

func NewWarning(text string) *WarningEvent

type WebhookCalledEvent ¶

type WebhookCalledEvent struct {
	BaseEvent

	*flows.HTTPLogWithoutTime

	Resthook   string     `json:"resthook,omitempty"`
	Extraction Extraction `json:"extraction"`
}

WebhookCalledEvent events are created when a webhook is called. The event contains the URL and the status of the response, as well as a full dump of the request and response.

{
  "type": "webhook_called",
  "created_on": "2006-01-02T15:04:05Z",
  "url": "http://localhost:49998/?cmd=success",
  "status": "success",
  "status_code": 200,
  "elapsed_ms": 123,
  "retries": 0,
  "request": "GET /?format=json HTTP/1.1",
  "response": "HTTP/1.1 200 OK\r\n\r\n{\"ip\":\"190.154.48.130\"}",
  "extraction": "valid"
}

@event webhook_called

func NewWebhookCalled(call *flows.WebhookCall, status flows.CallStatus, resthook string) *WebhookCalledEvent