actions

type AddContactGroupsAction ¶ added in v0.6.0

type AddContactGroupsAction struct {
	Groups []*assets.GroupReference `json:"groups" validate:"required,dive"`
	// contains filtered or unexported fields
}

AddContactGroupsAction can be used to add a contact to one or more groups. A [event:contact_groups_changed] event will be created for the groups which the contact has been added to.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "add_contact_groups",
  "groups": [{
    "uuid": "1e1ce1e1-9288-4504-869e-022d1003c72a",
    "name": "Customers"
  }]
}

@action add_contact_groups

func NewAddContactGroups(uuid flows.ActionUUID, groups []*assets.GroupReference) *AddContactGroupsAction

func (a *AddContactGroupsAction) AllowedFlowTypes() []flows.FlowType

func (a *AddContactGroupsAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *AddContactGroupsAction) LocalizationUUID() uuids.UUID

func (a *AddContactGroupsAction) Type() string

func (a *AddContactGroupsAction) UUID() flows.ActionUUID

func (a *AddContactGroupsAction) Validate() error

type AddContactURNAction ¶ added in v0.6.0

type AddContactURNAction struct {
	Scheme string `json:"scheme" validate:"urnscheme"`
	Path   string `json:"path" validate:"required" engine:"evaluated"`
	// contains filtered or unexported fields
}

AddContactURNAction can be used to add a URN to the current contact. A [event:contact_urns_changed] event will be created when this action is encountered.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "add_contact_urn",
  "scheme": "tel",
  "path": "@results.phone_number.value"
}

@action add_contact_urn

func NewAddContactURN(uuid flows.ActionUUID, scheme string, path string) *AddContactURNAction

func (a *AddContactURNAction) AllowedFlowTypes() []flows.FlowType

func (a *AddContactURNAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *AddContactURNAction) LocalizationUUID() uuids.UUID

func (a *AddContactURNAction) Type() string

func (a *AddContactURNAction) UUID() flows.ActionUUID

func (a *AddContactURNAction) Validate() error

type AddInputLabelsAction ¶ added in v0.6.0

type AddInputLabelsAction struct {
	Labels []*assets.LabelReference `json:"labels" validate:"required,dive"`
	// contains filtered or unexported fields
}

AddInputLabelsAction can be used to add labels to the last user input on a flow. An [event:input_labels_added] event will be created with the labels added when this action is encountered. If there is no user input at that point then this action will be ignored.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "add_input_labels",
  "labels": [{
    "uuid": "3f65d88a-95dc-4140-9451-943e94e06fea",
    "name": "Spam"
  }]
}

@action add_input_labels

func NewAddInputLabels(uuid flows.ActionUUID, labels []*assets.LabelReference) *AddInputLabelsAction

func (a *AddInputLabelsAction) AllowedFlowTypes() []flows.FlowType

func (a *AddInputLabelsAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *AddInputLabelsAction) LocalizationUUID() uuids.UUID

func (a *AddInputLabelsAction) Type() string

func (a *AddInputLabelsAction) UUID() flows.ActionUUID

func (a *AddInputLabelsAction) Validate() error

type CallClassifierAction ¶ added in v0.115.3

type CallClassifierAction struct {
	Classifier *assets.ClassifierReference `json:"classifier" validate:"required"`
	Input      string                      `json:"input" validate:"required" engine:"evaluated"`
	ResultName string                      `json:"result_name" validate:"required"`
	// contains filtered or unexported fields
}

CallClassifierAction can be used to classify the intent and entities from a given input using an NLU classifier. It always saves a result indicating whether the classification was successful, skipped or failed, and what the extracted intents and entities were.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "call_classifier",
  "classifier": {
    "uuid": "1c06c884-39dd-4ce4-ad9f-9a01cbe6c000",
    "name": "Booking"
  },
  "input": "@input.text",
  "result_name": "Intent"
}

@action call_classifier

func NewCallClassifier(uuid flows.ActionUUID, classifier *assets.ClassifierReference, input string, resultName string) *CallClassifierAction

func (a *CallClassifierAction) AllowedFlowTypes() []flows.FlowType

func (a *CallClassifierAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *CallClassifierAction) LocalizationUUID() uuids.UUID

func (a *CallClassifierAction) Results(include func(*flows.ResultInfo))

func (a *CallClassifierAction) Type() string

func (a *CallClassifierAction) UUID() flows.ActionUUID

func (a *CallClassifierAction) Validate() error

type CallResthookAction ¶ added in v0.10.20

type CallResthookAction struct {
	Resthook   string `json:"resthook" validate:"required"`
	ResultName string `json:"result_name,omitempty"`
	// contains filtered or unexported fields
}

CallResthookAction can be used to call a resthook.

A [event:webhook_called] event will be created for each subscriber of the resthook with the results of the HTTP call. If the action has `result_name` set, a result will be created with that name, and if the resthook returns valid JSON, that will be accessible through `extra` on the result.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "call_resthook",
  "resthook": "new-registration"
}

@action call_resthook

func NewCallResthook(uuid flows.ActionUUID, resthook string, resultName string) *CallResthookAction

func (a *CallResthookAction) AllowedFlowTypes() []flows.FlowType

func (a *CallResthookAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *CallResthookAction) LocalizationUUID() uuids.UUID

func (a *CallResthookAction) Results(include func(*flows.ResultInfo))

func (a *CallResthookAction) Type() string

func (a *CallResthookAction) UUID() flows.ActionUUID

func (a *CallResthookAction) Validate() error

type CallWebhookAction ¶ added in v0.6.0

type CallWebhookAction struct {
	Method     string            `json:"method" validate:"required,http_method"`
	URL        string            `json:"url" validate:"required" engine:"evaluated"`
	Headers    map[string]string `json:"headers,omitempty" engine:"evaluated"`
	Body       string            `json:"body,omitempty" engine:"evaluated"`
	ResultName string            `json:"result_name,omitempty"`
	// contains filtered or unexported fields
}

CallWebhookAction can be used to call an external service. The body, header and url fields may be templates and will be evaluated at runtime. A [event:webhook_called] event will be created based on the results of the HTTP call. If this action has a `result_name`, then additionally it will create a new result with that name. The value of the result will be the status code and the category will be `Success` or `Failed`. If the webhook returned valid JSON which is less than 10000 bytes, that will be accessible through `extra` on the result. The last JSON response from a webhook call in the current sprint will additionally be accessible in expressions as `@webhook` regardless of size.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "call_webhook",
  "method": "GET",
  "url": "http://localhost:49998/?cmd=success",
  "headers": {
    "Authorization": "Token AAFFZZHH"
  },
  "result_name": "webhook"
}

@action call_webhook

func NewCallWebhook(uuid flows.ActionUUID, method string, url string, headers map[string]string, body string, resultName string) *CallWebhookAction

func (a *CallWebhookAction) AllowedFlowTypes() []flows.FlowType

func (a *CallWebhookAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *CallWebhookAction) LocalizationUUID() uuids.UUID

func (a *CallWebhookAction) Results(include func(*flows.ResultInfo))

func (a *CallWebhookAction) Type() string

func (a *CallWebhookAction) UUID() flows.ActionUUID

func (a *CallWebhookAction) Validate() error

type EnterFlowAction ¶ added in v0.115.3

type EnterFlowAction struct {
	Flow     *assets.FlowReference `json:"flow" validate:"required"`
	Terminal bool                  `json:"terminal,omitempty"`
	// contains filtered or unexported fields
}

EnterFlowAction can be used to start a contact down another flow. The current flow will pause until the subflow exits or expires.

A [event:flow_entered] event will be created to record that the flow was started.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "enter_flow",
  "flow": {"uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d", "name": "Collect Language"},
  "terminal": false
}

@action enter_flow

func NewEnterFlow(uuid flows.ActionUUID, flow *assets.FlowReference, terminal bool) *EnterFlowAction

func (a *EnterFlowAction) AllowedFlowTypes() []flows.FlowType

func (a *EnterFlowAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *EnterFlowAction) LocalizationUUID() uuids.UUID

func (a *EnterFlowAction) Type() string

func (a *EnterFlowAction) UUID() flows.ActionUUID

func (a *EnterFlowAction) Validate() error

type OpenTicketAction ¶ added in v0.115.3

type OpenTicketAction struct {
	Ticketer   *assets.TicketerReference `json:"ticketer" validate:"required,dive"`
	Topic      *assets.TopicReference    `json:"topic" validate:"omitempty,dive"`
	Body       string                    `json:"body" engine:"evaluated"`
	Assignee   *assets.UserReference     `json:"assignee" validate:"omitempty,dive"`
	ResultName string                    `json:"result_name" validate:"required"`
	// contains filtered or unexported fields
}

OpenTicketAction is used to open a ticket for the contact.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "open_ticket",
  "ticketer": {
    "uuid": "19dc6346-9623-4fe4-be80-538d493ecdf5",
    "name": "Support Tickets"
  },
  "topic": {
    "uuid": "472a7a73-96cb-4736-b567-056d987cc5b4",
    "name": "Weather"
  },
  "body": "@input",
  "assignee": {"email": "bob@nyaruka.com", "name": "Bob McTickets"},
  "result_name": "Help Ticket"
}

@action open_ticket

func NewOpenTicket(uuid flows.ActionUUID, ticketer *assets.TicketerReference, topic *assets.TopicReference, body string, assignee *assets.UserReference, resultName string) *OpenTicketAction

func (a *OpenTicketAction) AllowedFlowTypes() []flows.FlowType

func (a *OpenTicketAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *OpenTicketAction) LocalizationUUID() uuids.UUID

func (a *OpenTicketAction) Type() string

func (a *OpenTicketAction) UUID() flows.ActionUUID

func (a *OpenTicketAction) Validate() error

type PlayAudioAction ¶ added in v0.115.3

type PlayAudioAction struct {
	AudioURL string `json:"audio_url" validate:"required" engine:"localized,evaluated"`
	// contains filtered or unexported fields
}

PlayAudioAction can be used to play an audio recording in a voice flow. It will generate an [event:ivr_created] event if there is a valid audio URL. This will contain a message which the caller should handle as an IVR play command using the audio attachment.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "play_audio",
  "audio_url": "http://uploads.temba.io/2353262.m4a"
}

@action play_audio

func NewPlayAudio(uuid flows.ActionUUID, audioURL string) *PlayAudioAction

func (a *PlayAudioAction) AllowedFlowTypes() []flows.FlowType

func (a *PlayAudioAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *PlayAudioAction) LocalizationUUID() uuids.UUID

func (a *PlayAudioAction) Type() string

func (a *PlayAudioAction) UUID() flows.ActionUUID

func (a *PlayAudioAction) Validate() error

type RemoveContactGroupsAction ¶ added in v0.6.0

type RemoveContactGroupsAction struct {
	Groups    []*assets.GroupReference `json:"groups,omitempty" validate:"dive"`
	AllGroups bool                     `json:"all_groups,omitempty"`
	// contains filtered or unexported fields
}

RemoveContactGroupsAction can be used to remove a contact from one or more groups. A [event:contact_groups_changed] event will be created for the groups which the contact is removed from. Groups can either be explicitly provided or `all_groups` can be set to true to remove the contact from all non-query based groups.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "remove_contact_groups",
  "groups": [{
    "uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d",
    "name": "Registered Users"
  }]
}

@action remove_contact_groups

func NewRemoveContactGroups(uuid flows.ActionUUID, groups []*assets.GroupReference, allGroups bool) *RemoveContactGroupsAction

func (a *RemoveContactGroupsAction) AllowedFlowTypes() []flows.FlowType

func (a *RemoveContactGroupsAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *RemoveContactGroupsAction) LocalizationUUID() uuids.UUID

func (a *RemoveContactGroupsAction) Type() string

func (a *RemoveContactGroupsAction) UUID() flows.ActionUUID

func (a *RemoveContactGroupsAction) Validate() error

type SayMsgAction ¶ added in v0.115.3

type SayMsgAction struct {
	Text     string `json:"text" validate:"required" engine:"localized,evaluated"`
	AudioURL string `json:"audio_url,omitempty"`
	// contains filtered or unexported fields
}

SayMsgAction can be used to communicate with the contact in a voice flow by either reading a message with TTS or playing a pre-recorded audio file. It will generate an [event:ivr_created] event if there is a valid audio URL or backdown text. This will contain a message which the caller should handle as an IVR play command if it has an audio attachment, or otherwise an IVR say command using the message text.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "say_msg",
  "audio_url": "http://uploads.temba.io/2353262.m4a",
  "text": "Hi @contact.name, are you ready to complete today's survey?"
}

@action say_msg

func NewSayMsg(uuid flows.ActionUUID, text string, audioURL string) *SayMsgAction

func (a *SayMsgAction) AllowedFlowTypes() []flows.FlowType

func (a *SayMsgAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SayMsgAction) LocalizationUUID() uuids.UUID

func (a *SayMsgAction) Type() string

func (a *SayMsgAction) UUID() flows.ActionUUID

func (a *SayMsgAction) Validate() error

type SendBroadcastAction ¶ added in v0.6.0

type SendBroadcastAction struct {
	// contains filtered or unexported fields
}

SendBroadcastAction can be used to send a message to one or more contacts. It accepts a list of URNs, a list of groups and a list of contacts.

The URNs and text fields may be templates. A [event:broadcast_created] event will be created for each unique urn, contact and group with the evaluated text.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "send_broadcast",
  "urns": ["tel:+12065551212"],
  "text": "Hi @contact.name, are you ready to complete today's survey?"
}

@action send_broadcast

func NewSendBroadcast(uuid flows.ActionUUID, text string, attachments []string, quickReplies []string, urns []urns.URN, contacts []*flows.ContactReference, groups []*assets.GroupReference, legacyVars []string) *SendBroadcastAction

func (a *SendBroadcastAction) AllowedFlowTypes() []flows.FlowType

func (a *SendBroadcastAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SendBroadcastAction) LocalizationUUID() uuids.UUID

func (a *SendBroadcastAction) Type() string

func (a *SendBroadcastAction) UUID() flows.ActionUUID

func (a *SendBroadcastAction) Validate() error

type SendEmailAction ¶ added in v0.6.0

type SendEmailAction struct {
	Addresses []string `json:"addresses" validate:"required,min=1" engine:"evaluated"`
	Subject   string   `json:"subject" validate:"required" engine:"localized,evaluated"`
	Body      string   `json:"body" validate:"required" engine:"localized,evaluated"`
	// contains filtered or unexported fields
}

SendEmailAction can be used to send an email to one or more recipients. The subject, body and addresses can all contain expressions.

An [event:email_sent] event will be created if the email could be sent.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "send_email",
  "addresses": ["@urns.mailto"],
  "subject": "Here is your activation token",
  "body": "Your activation token is @contact.fields.activation_token"
}

@action send_email

func NewSendEmail(uuid flows.ActionUUID, addresses []string, subject string, body string) *SendEmailAction

func (a *SendEmailAction) AllowedFlowTypes() []flows.FlowType

func (a *SendEmailAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SendEmailAction) LocalizationUUID() uuids.UUID

func (a *SendEmailAction) Type() string

func (a *SendEmailAction) UUID() flows.ActionUUID

func (a *SendEmailAction) Validate() error

type SendMsgAction ¶

type SendMsgAction struct {
	AllURNs    bool           `json:"all_urns,omitempty"`
	Templating *Templating    `json:"templating,omitempty" validate:"omitempty,dive"`
	Topic      flows.MsgTopic `json:"topic,omitempty" validate:"omitempty,msg_topic"`
	// contains filtered or unexported fields
}

SendMsgAction can be used to reply to the current contact in a flow. The text field may contain templates. The action will attempt to find pairs of URNs and channels which can be used for sending. If it can't find such a pair, it will create a message without a channel or URN.

A [event:msg_created] event will be created with the evaluated text.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "send_msg",
  "text": "Hi @contact.name, are you ready to complete today's survey?",
  "attachments": [],
  "all_urns": false,
  "templating": {
    "uuid": "32c2ead6-3fa3-4402-8e27-9cc718175c5a",
    "template": {
      "uuid": "3ce100b7-a734-4b4e-891b-350b1279ade2",
      "name": "revive_issue"
    },
    "variables": ["@contact.name"]
  },
  "topic": "event"
}

@action send_msg

func NewSendMsg(uuid flows.ActionUUID, text string, attachments []string, quickReplies []string, allURNs bool) *SendMsgAction

func (a *SendMsgAction) AllowedFlowTypes() []flows.FlowType

func (a *SendMsgAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SendMsgAction) LocalizationUUID() uuids.UUID

func (a *SendMsgAction) Type() string

func (a *SendMsgAction) UUID() flows.ActionUUID

func (a *SendMsgAction) Validate() error

type SetContactChannelAction ¶ added in v0.6.0

type SetContactChannelAction struct {
	Channel *assets.ChannelReference `json:"channel" validate:"omitempty,dive"`
	// contains filtered or unexported fields
}

SetContactChannelAction can be used to change or clear the preferred channel of the current contact.

Because channel affinity is a property of a contact's URNs, a [event:contact_urns_changed] event will be created if any changes are made to the contact's URNs.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_channel",
  "channel": {"uuid": "4bb288a0-7fca-4da1-abe8-59a593aff648", "name": "Facebook Channel"}
}

@action set_contact_channel

func NewSetContactChannel(uuid flows.ActionUUID, channel *assets.ChannelReference) *SetContactChannelAction

func (a *SetContactChannelAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactChannelAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactChannelAction) LocalizationUUID() uuids.UUID

func (a *SetContactChannelAction) Type() string

func (a *SetContactChannelAction) UUID() flows.ActionUUID

func (a *SetContactChannelAction) Validate() error

type SetContactFieldAction ¶ added in v0.6.0

type SetContactFieldAction struct {
	Field *assets.FieldReference `json:"field" validate:"required"`
	Value string                 `json:"value" engine:"evaluated"`
	// contains filtered or unexported fields
}

SetContactFieldAction can be used to update a field value on the contact. The value is a localizable template and white space is trimmed from the final value. An empty string clears the value. A [event:contact_field_changed] event will be created with the corresponding value.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_field",
  "field": {"key": "gender", "name": "Gender"},
  "value": "Female"
}

@action set_contact_field

func NewSetContactField(uuid flows.ActionUUID, field *assets.FieldReference, value string) *SetContactFieldAction

func (a *SetContactFieldAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactFieldAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactFieldAction) LocalizationUUID() uuids.UUID

func (a *SetContactFieldAction) Type() string

func (a *SetContactFieldAction) UUID() flows.ActionUUID

func (a *SetContactFieldAction) Validate() error

type SetContactLanguageAction ¶ added in v0.10.0

type SetContactLanguageAction struct {
	Language string `json:"language" engine:"evaluated"`
	// contains filtered or unexported fields
}

SetContactLanguageAction can be used to update the name of the contact. The language is a localizable template and white space is trimmed from the final value. An empty string clears the language. A [event:contact_language_changed] event will be created with the corresponding value.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_language",
  "language": "eng"
}

@action set_contact_language

func NewSetContactLanguage(uuid flows.ActionUUID, language string) *SetContactLanguageAction

func (a *SetContactLanguageAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactLanguageAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactLanguageAction) LocalizationUUID() uuids.UUID

func (a *SetContactLanguageAction) Type() string

func (a *SetContactLanguageAction) UUID() flows.ActionUUID

func (a *SetContactLanguageAction) Validate() error

type SetContactNameAction ¶ added in v0.10.0

type SetContactNameAction struct {
	Name string `json:"name" engine:"evaluated"`
	// contains filtered or unexported fields
}

SetContactNameAction can be used to update the name of the contact. The name is a localizable template and white space is trimmed from the final value. An empty string clears the name. A [event:contact_name_changed] event will be created with the corresponding value.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_name",
  "name": "Bob Smith"
}

@action set_contact_name

func NewSetContactName(uuid flows.ActionUUID, name string) *SetContactNameAction

func (a *SetContactNameAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactNameAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactNameAction) LocalizationUUID() uuids.UUID

func (a *SetContactNameAction) Type() string

func (a *SetContactNameAction) UUID() flows.ActionUUID

func (a *SetContactNameAction) Validate() error

type SetContactStatusAction ¶ added in v0.115.3

type SetContactStatusAction struct {
	Status flows.ContactStatus `json:"status" validate:"contact_status"`
	// contains filtered or unexported fields
}

SetContactStatusAction can be used to update the status of the contact, e.g. to block or unblock the contact. A [event:contact_status_changed] event will be created with the corresponding value.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_status",
  "status": "blocked"
}

@action set_contact_status

func NewSetContactStatus(uuid flows.ActionUUID, status flows.ContactStatus) *SetContactStatusAction

func (a *SetContactStatusAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactStatusAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactStatusAction) LocalizationUUID() uuids.UUID

func (a *SetContactStatusAction) Type() string

func (a *SetContactStatusAction) UUID() flows.ActionUUID

func (a *SetContactStatusAction) Validate() error

type SetContactTimezoneAction ¶ added in v0.10.0

type SetContactTimezoneAction struct {
	Timezone string `json:"timezone" engine:"evaluated"`
	// contains filtered or unexported fields
}

SetContactTimezoneAction can be used to update the timezone of the contact. The timezone is a localizable template and white space is trimmed from the final value. An empty string clears the timezone. A [event:contact_timezone_changed] event will be created with the corresponding value.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_contact_timezone",
  "timezone": "Africa/Kigali"
}

@action set_contact_timezone

func NewSetContactTimezone(uuid flows.ActionUUID, timezone string) *SetContactTimezoneAction

func (a *SetContactTimezoneAction) AllowedFlowTypes() []flows.FlowType

func (a *SetContactTimezoneAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetContactTimezoneAction) LocalizationUUID() uuids.UUID

func (a *SetContactTimezoneAction) Type() string

func (a *SetContactTimezoneAction) UUID() flows.ActionUUID

func (a *SetContactTimezoneAction) Validate() error

type SetRunResultAction ¶ added in v0.6.0

type SetRunResultAction struct {
	Name     string `json:"name" validate:"required"`
	Value    string `json:"value" engine:"evaluated"`
	Category string `json:"category,omitempty" engine:"localized"`
	// contains filtered or unexported fields
}

SetRunResultAction can be used to save a result for a flow. The result will be available in the context for the run as @results.[name]. The optional category can be used as a way of categorizing results, this can be useful for reporting or analytics.

Both the value and category fields may be templates. A [event:run_result_changed] event will be created with the final values.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "set_run_result",
  "name": "Gender",
  "value": "m",
  "category": "Male"
}

@action set_run_result

func NewSetRunResult(uuid flows.ActionUUID, name string, value string, category string) *SetRunResultAction

func (a *SetRunResultAction) AllowedFlowTypes() []flows.FlowType

func (a *SetRunResultAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *SetRunResultAction) LocalizationUUID() uuids.UUID

func (a *SetRunResultAction) Results(include func(*flows.ResultInfo))

func (a *SetRunResultAction) Type() string

func (a *SetRunResultAction) UUID() flows.ActionUUID

func (a *SetRunResultAction) Validate() error

type StartSessionAction ¶ added in v0.4.0

type StartSessionAction struct {
	Flow          *assets.FlowReference `json:"flow" validate:"required"`
	Exclusions    events.Exclusions     `json:"exclusions"`
	CreateContact bool                  `json:"create_contact,omitempty"`
	// contains filtered or unexported fields
}

StartSessionAction can be used to trigger sessions for other contacts and groups. A [event:session_triggered] event will be created and it's the responsibility of the caller to act on that by initiating a new session with the flow engine.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "start_session",
  "flow": {"uuid": "b7cf0d83-f1c9-411c-96fd-c511a4cfa86d", "name": "Registration"},
  "groups": [
    {"uuid": "1e1ce1e1-9288-4504-869e-022d1003c72a", "name": "Customers"}
  ],
  "exclusions": {"in_a_flow": true}
}

@action start_session

func NewStartSession(uuid flows.ActionUUID, flow *assets.FlowReference, urns []urns.URN, contacts []*flows.ContactReference, groups []*assets.GroupReference, legacyVars []string, createContact bool) *StartSessionAction

func (a *StartSessionAction) AllowedFlowTypes() []flows.FlowType

func (a *StartSessionAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *StartSessionAction) LocalizationUUID() uuids.UUID

func (a *StartSessionAction) Type() string

func (a *StartSessionAction) UUID() flows.ActionUUID

func (a *StartSessionAction) Validate() error

type Templating ¶ added in v0.115.3

type Templating struct {
	UUID      uuids.UUID                `json:"uuid" validate:"required,uuid4"`
	Template  *assets.TemplateReference `json:"template" validate:"required"`
	Variables []string                  `json:"variables" engine:"localized,evaluated"`
}

Templating represents the templating that should be used if possible

func (t *Templating) LocalizationUUID() uuids.UUID

type TransferAirtimeAction ¶ added in v0.115.3

type TransferAirtimeAction struct {
	Amounts    map[string]decimal.Decimal `json:"amounts" validate:"required"`
	ResultName string                     `json:"result_name" validate:"required"`
	// contains filtered or unexported fields
}

TransferAirtimeAction attempts to make an airtime transfer to the contact.

An [event:airtime_transferred] event will be created if the airtime could be sent.

{
  "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
  "type": "transfer_airtime",
  "amounts": {"RWF": 500, "USD": 0.5},
  "result_name": "Reward Transfer"
}

@action transfer_airtime

func NewTransferAirtime(uuid flows.ActionUUID, amounts map[string]decimal.Decimal, resultName string) *TransferAirtimeAction

func (a *TransferAirtimeAction) AllowedFlowTypes() []flows.FlowType

func (a *TransferAirtimeAction) Execute(run flows.Run, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error

func (a *TransferAirtimeAction) LocalizationUUID() uuids.UUID

func (a *TransferAirtimeAction) Results(include func(*flows.ResultInfo))

func (a *TransferAirtimeAction) Type() string

func (a *TransferAirtimeAction) UUID() flows.ActionUUID

func (a *TransferAirtimeAction) Validate() error