Notify workspace members

Read orbi.project.members. Each person has a name, an email address, and a role. You can write only to those people. Each person gets their own email. There is no CC.

async ({ notifications }) => {
  return await notifications.send({
    to: "sponsor",
    subject: "Run finished",
    text: "The goal was reached.",
  })
}

to: "sponsor" writes to the sponsor. to: "members" writes to everyone in the workspace. You can also pass one member's id or email from orbi.project.members. The message comes from app@orbitype.com.

Plain text is sent as HTML inside the Orbitype layout. Pass html when you already have HTML. Set layout: false when that HTML should be the whole message.

await notifications.send({
  to: "members",
  subject: "Update",
  html: "
Hello
",
  layout: false,
})

In the agent wizard, pick Workspace Notification. It writes to the sponsor unless you set all members. You do not enter an SMTP host or password. Pass origin with the agent's name so the inbox shows who sent it.

Set channels to ["email"], ["push"], or both. Email is the default. Push saves the message on that person's account, across every workspace, and sends it to each browser and phone they subscribed. The device they are looking at shows a toast and a short sound. The others show a browser notification. Subscribing another device does not remove the earlier ones. Each person who is notified costs 1 credit, even when both channels are used. Pass origin with a short name, such as the agent name.

await notifications.send({
  to: "sponsor",
  subject: "Goal reached",
  text: "The run ended.",
  origin: "Sales researcher",
  channels: ["email", "push"],
})

An address that is not a workspace member is not sent. The same applies to CC, a different From address, and a call with no subject.