On mailhook

onMailhook creates a managed @automations.automate.ax address. Each declaration gets a unique address by default; scope: "automation" or scope: "project" shares an address at that scope.

Example

automations/reply-inbox.automation.ts

import {
  automation,
  correlate,
  correlationId,
  filter,
  markSignificant,
  onDashboardRun,
  onMailhook,
  sendEmail,
  t,
  transform,
} from "automate.ax"

export default automation("Reply inbox", () => {
  const run = onDashboardRun({ title: "Request a reply" })
  const inbox = onMailhook({ scope: "automation" })
  const requestId = correlationId(run)

  sendEmail({
    replyTo: { plusPath: requestId, scope: "automation" },
    subject: "Reply to this automation",
    text: t`This message was requested by ${run.triggeredBy.name}.`,
  })

  const reply = filter(
    inbox,
    ({ isReply, plusPath }) => isReply && plusPath !== null,
  )

  const matched = correlate(
    [requestId.keyBy((id) => id), reply.keyBy(({ plusPath }) => plusPath)],
    { occurrenceTtl: "30d", ordered: true },
  )
  const correlatedReply = transform(
    [matched, reply],
    (_matched, replyEvent) => replyEvent,
  )

  markSignificant(correlatedReply)
})

Selecting Request a reply in the dashboard sends one email to every current organization member and uses the Platform email allowance. The matching reply starts a separate root run, correlate joins it to the dashboard run through plusPath, and markSignificant keeps the correlated run visible without sending another email. inbox.address is the deployed inbound address as a static string. Use it as sendEmail’s replyTo for an exact trigger address. For automation- or project-scoped mailhooks, you can instead pass { scope } and an optional static or signal-valued plusPath.

Options

Option	Type	Required	Default	Description
`scope`	`"trigger" \| "automation" \| "project"`	No	`"trigger"`	Scope where the trigger receives email.

onMailhook configuration is static and can’t use signals. Trigger scope gives each declaration a unique address. Automation scope shares an address across the automation. Project scope shares an address across the project. Every active subscription at that scope receives matching email.

Plus routing

Append +suffix before the @ to route related addresses through the same mailhook. For example, if inbox.address is abc@automations.automate.ax, email sent to abc+invoices@automations.automate.ax sets plusPath to "invoices". Use correlationId when the originating signal has no natural correlation key. Use valid email local-part characters and keep the complete local part before @ within the 64-byte email limit.

Trigger data

onMailhook returns an email signal with static address: string and this message data:

Property	Type	Description
`senderAddress`	`string \| null`	Parsed sender address.
`senderName`	`string \| null`	Parsed sender display name.
`additionalRecipients`	`string[]`	Other To, Cc, and Bcc recipients.
`subject`	`string`	Message subject.
`text`	`string \| null`	Plain-text body.
`html`	`string \| null`	HTML body. Treat it as untrusted content.
`attachments`	`File[]`	Attached files, including inline Multipurpose Internet Mail Extensions (MIME) parts.
`headers`	`Record<string, string>`	Original headers with lowercase names.
`messageId`	`string`	On-the-wire RFC 5322 Message-ID. Use it as `In-Reply-To` when replying to this message.
`inReplyTo`	`string \| null`	On-the-wire RFC 5322 Message-ID of this message’s parent.
`references`	`string[]`	On-the-wire RFC 5322 Message-IDs in the conversation ancestry. Append `messageId` when building a reply’s `References` header. When empty, start with `inReplyTo` if present.
`isReply`	`boolean`	Whether an `In-Reply-To` header is present.
`plusPath`	`string \| null`	Suffix after `+` in the receiving address.
`receivedAt`	`Date`	Time Resend received the message.

Replies use the same trigger as other inbound email. Filter on isReply when an automation should only continue for replies.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Example

Options

Plus routing

Trigger data

​Example

​Options

​Plus routing

​Trigger data

Example

Options

Plus routing

Trigger data