actions

type AddContactGroupsAction ¶ added in v0.6.0

type AddContactGroupsAction struct {
	BaseAction

	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 NewAddContactGroupsAction(uuid flows.ActionUUID, groups []*assets.GroupReference) *AddContactGroupsAction

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

func (a *AddContactGroupsAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *AddContactGroupsAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type AddContactURNAction ¶ added in v0.6.0

type AddContactURNAction struct {
	BaseAction

	Scheme string `json:"scheme" validate:"urnscheme"`
	Path   string `json:"path" validate:"required"`
	// 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"
}

@action add_contact_urn

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

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

func (a *AddContactURNAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *AddContactURNAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type AddInputLabelsAction ¶ added in v0.6.0

type AddInputLabelsAction struct {
	BaseAction

	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 NewAddInputLabelsAction(uuid flows.ActionUUID, labels []*assets.LabelReference) *AddInputLabelsAction

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

func (a *AddInputLabelsAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *AddInputLabelsAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type BaseAction ¶

type BaseAction struct {
	Type_ string           `json:"type" validate:"required"`
	UUID_ flows.ActionUUID `json:"uuid" validate:"required,uuid4"`
}

BaseAction is our base action

func NewBaseAction(typeName string, uuid flows.ActionUUID) BaseAction

func (a *BaseAction) Type() string

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

type CallResthookAction ¶ added in v0.10.20

type CallResthookAction struct {
	BaseAction

	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 NewCallResthookAction(uuid flows.ActionUUID, resthook string, resultName string) *CallResthookAction

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

func (a *CallResthookAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *CallResthookAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type CallWebhookAction ¶ added in v0.6.0

type CallWebhookAction struct {
	BaseAction

	Method     string            `json:"method" validate:"required,http_method"`
	URL        string            `json:"url" validate:"required"`
	Headers    map[string]string `json:"headers,omitempty"`
	Body       string            `json:"body,omitempty"`
	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 addtionally it will create a new result with that name. If the webhook returned valid JSON, that will be accessible through `extra` on the result.

{
  "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 NewCallWebhookAction(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.FlowRun, step flows.Step) error

func (a *CallWebhookAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type RemoveContactGroupsAction ¶ added in v0.6.0

type RemoveContactGroupsAction struct {
	BaseAction

	Groups    []*assets.GroupReference `json:"groups,omitempty" validate:"dive"`
	AllGroups bool                     `json:"all_groups"`
	// 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-dynamic 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 NewRemoveContactGroupsAction(uuid flows.ActionUUID, groups []*assets.GroupReference, allGroups bool) *RemoveContactGroupsAction

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

func (a *RemoveContactGroupsAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *RemoveContactGroupsAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SendBroadcastAction ¶ added in v0.6.0

type SendBroadcastAction struct {
	BaseAction

	Text         string                    `json:"text"`
	Attachments  []string                  `json:"attachments"`
	QuickReplies []string                  `json:"quick_replies,omitempty"`
	URNs         []urns.URN                `json:"urns,omitempty"`
	Contacts     []*flows.ContactReference `json:"contacts,omitempty" validate:"dive"`
	Groups       []*assets.GroupReference  `json:"groups,omitempty" validate:"dive"`
	LegacyVars   []string                  `json:"legacy_vars,omitempty"`
	// 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 NewSendBroadcastAction(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.FlowRun, step flows.Step) error

func (a *SendBroadcastAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SendEmailAction ¶ added in v0.6.0

type SendEmailAction struct {
	BaseAction

	Addresses []string `json:"addresses" validate:"required,min=1"`
	Subject   string   `json:"subject" validate:"required"`
	Body      string   `json:"body" validate:"required"`
	// 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_created] event will be created for each email address.

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

@action send_email

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

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

func (a *SendEmailAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SendEmailAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SendMsgAction ¶

type SendMsgAction struct {
	BaseAction

	Text         string   `json:"text"`
	Attachments  []string `json:"attachments,omitempty"`
	QuickReplies []string `json:"quick_replies,omitempty"`
	AllURNs      bool     `json:"all_urns,omitempty"`
	// 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
}

@action send_msg

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

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

func (a *SendMsgAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SendMsgAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetContactChannelAction ¶ added in v0.6.0

type SetContactChannelAction struct {
	BaseAction

	Channel *assets.ChannelReference `json:"channel"`
	// 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 NewSetContactChannelAction(uuid flows.ActionUUID, channel *assets.ChannelReference) *SetContactChannelAction

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

func (a *SetContactChannelAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetContactChannelAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetContactFieldAction ¶ added in v0.6.0

type SetContactFieldAction struct {
	BaseAction

	Field *assets.FieldReference `json:"field" validate:"required"`
	Value string                 `json:"value"`
	// 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 NewSetContactFieldAction(uuid flows.ActionUUID, field *assets.FieldReference, value string) *SetContactFieldAction

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

func (a *SetContactFieldAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetContactFieldAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetContactLanguageAction ¶ added in v0.10.0

type SetContactLanguageAction struct {
	BaseAction

	Language string `json:"language"`
	// 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 NewSetContactLanguageAction(uuid flows.ActionUUID, language string) *SetContactLanguageAction

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

func (a *SetContactLanguageAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetContactLanguageAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetContactNameAction ¶ added in v0.10.0

type SetContactNameAction struct {
	BaseAction

	Name string `json:"name"`
	// 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 NewSetContactNameAction(uuid flows.ActionUUID, name string) *SetContactNameAction

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

func (a *SetContactNameAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetContactNameAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetContactTimezoneAction ¶ added in v0.10.0

type SetContactTimezoneAction struct {
	BaseAction

	Timezone string `json:"timezone"`
	// 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 NewSetContactTimezoneAction(uuid flows.ActionUUID, timezone string) *SetContactTimezoneAction

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

func (a *SetContactTimezoneAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetContactTimezoneAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type SetRunResultAction ¶ added in v0.6.0

type SetRunResultAction struct {
	BaseAction

	Name     string `json:"name" validate:"required"`
	Value    string `json:"value" validate:"required"`
	Category string `json:"category"`
	// 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 NewSetRunResultAction(uuid flows.ActionUUID, name string, value string, category string) *SetRunResultAction

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

func (a *SetRunResultAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *SetRunResultAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type StartFlowAction ¶

type StartFlowAction struct {
	BaseAction

	Flow     *assets.FlowReference `json:"flow" validate:"required"`
	Terminal bool                  `json:"terminal"`
	// contains filtered or unexported fields
}

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

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

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

@action start_flow

func NewStartFlowAction(uuid flows.ActionUUID, flow *assets.FlowReference, terminal bool) *StartFlowAction

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

func (a *StartFlowAction) Execute(run flows.FlowRun, step flows.Step) error

func (a *StartFlowAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error

type StartSessionAction ¶ added in v0.4.0

type StartSessionAction struct {
	BaseAction

	Flow          *assets.FlowReference     `json:"flow" validate:"required"`
	URNs          []urns.URN                `json:"urns,omitempty"`
	Contacts      []*flows.ContactReference `json:"contacts,omitempty" validate:"dive"`
	Groups        []*assets.GroupReference  `json:"groups,omitempty" validate:"dive"`
	LegacyVars    []string                  `json:"legacy_vars,omitempty"`
	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"}
  ]
}

@action start_session

func NewStartSessionAction(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.FlowRun, step flows.Step) error

func (a *StartSessionAction) Validate(assets flows.SessionAssets, context *flows.ValidationContext) error