EmailgisticsAPI
WebhooksActions

Forward message action

Forward the received message to other recipients.

Forwards the triggering message to one or more recipients, optionally with a plain-text comment. There is no Cc, Bcc, HTML body, or variable substitution — this maps to the same forward behavior as the Forward action in Admin’s rule editor, not the more flexible sendMessage.

{
  "type":  "forwardMessage",
  "name":  "Forward to underwriting team",
  "value": {
    "toAddresses": [
      { "emailAddress": { "address": "agent1@acme.com", "name": "Agent 1" } },
      { "emailAddress": { "address": "agent2@acme.com", "name": "Agent 2" } }
    ],
    "comment": "Please review for coverage eligibility."
  }
}

Action object

type"forwardMessage"

Always "forwardMessage".

name?string

Optional label for diagnostics.

valueobject

See below.

value

toAddressesAddress[]

Recipients to forward to. Each entry is { emailAddress: { address, name } } — same shape as the addresses in the webhook request payload. There is no ccAddresses or bccAddresses for forward actions.

comment?string

Optional plain-text note prepended to the body of the forwarded message — it appears above the original message contents in the recipient’s inbox. No HTML, no variable substitution.

Address

{ "emailAddress": { "address": "agent@acme.com", "name": "Agent Name" } }

Limitations

  • Plain text only. The comment is treated as plain text.
  • No variables. Variable placeholders are not substituted in the comment.
  • No Cc or Bcc. All recipients go in toAddresses. If you need Cc or Bcc, use sendMessage with the original message inlined into the body.

On this page