Outcome
represents the result of having executed an Action
. Its general structure is as follows:Response
and Payload
types depends on the kind of Action
that was executed. Payload
type contains information about the exact payload that HAL used to execute the action, and can be thought of as the "input" part of executing an Action
. Email
action is shared between TransactionsTriggers, ContractsTriggers and EventsTriggers: body
and subject
fields contain the actual text that was sent via email, after the template has been applied.Webhook
action, on the other hand, has a different type for each possible Trigger. So far the following are supported:TransactionsTriggerWebhookPayload
:Decoded
field contains the decoded input data used for the specific transaction that matched. You can read more about it under the Matches page of this documentation.ContractsTriggerWebhookPayload
EventsTriggerWebhookPaylaod
:Slack
Action is very simple and it consists of a body
field only:Telegram
Actions is:Twitter
Action is:Discord
Action is:MailResponse
(for the Email
action) and WebhookResponse
for all the other supported actions.MailResponse
contains an ID for the email message, if sent correctly, or an error otherwise:WebhookResponse
is straightforward: