Enbbox Docs

In-App Channel

Add real-time in-app notifications to your Enbbox workflows. Define in-app notification content, action buttons, and avatar in TypeScript.

In-App Step

await step.inApp("new-comment", async () => ({
  subject: "New comment on your post",
  body: `${payload.authorName} commented: "${payload.comment}"`,
  avatar: payload.authorAvatar,
  redirect: {
    url: `/posts/${payload.postId}`,
  },
  primaryAction: {
    label: "View Comment",
    redirect: { url: `/posts/${payload.postId}#comment-${payload.commentId}` },
  },
  secondaryAction: {
    label: "Mark as Read",
  },
}));

In-App Options

OptionTypeDescription
subjectstringNotification title
bodystringNotification body text
avatarstringAvatar image URL
redirectobjectClick-through URL
primaryActionobjectPrimary CTA button
secondaryActionobjectSecondary CTA button

Display

In-app notifications appear in the <Inbox /> component. See Inbox Overview for integration details.

On this page