On label added - Automate.ax

onGmailLabelAdded subscribes an automation to label additions in the connected Gmail mailbox. It emits both user-label and system-label changes.

Example

automations/prioritize-customer-email.automation.ts

import { automation, filter } from "automate.ax"
import {
  markGmailMessagesAsImportant,
  onGmailLabelAdded,
} from "automate.ax/gmail"

export default automation("Prioritize customer email", () => {
  const customerEmail = filter(onGmailLabelAdded(), ({ labels }) =>
    labels.some(({ name }) => name === "Customer"),
  )

  markGmailMessagesAsImportant({
    messageIds: customerEmail.message.messageId,
  })
})

Options

Property	Type	Required	Description
`account`	`string \| IntegrationAccountReference<"google">`	No	Static Google account binding to watch. Defaults to the project’s default Google account binding.

The account selection must be static. Call onGmailLabelAdded() without an options object to use the default Google binding.

Trigger data

Returns a Signal<GmailLabelChange> for each Gmail history change:

interface GmailLabelChange {
  labels: {
    labelId: string
    name?: string
  }[]
  message: Message
}

message is the same fully parsed shape returned by Get message. One event can contain several labels when Gmail records them in the same change. Use labelId as the stable identity; name reflects the label’s current name when Gmail can resolve it.

⌘I