How does the Inbox fit into the notification lifecycle?
The Inbox component displays in-app notifications inside your application. It connects to the configured environment and subscriber so each user sees their own messages. When a workflow reaches an in-app step, it creates a message for that subscriber. The Inbox displays the notification and provides controls for reading it, following its actions, and managing preferences. Your application is responsible for identifying the correct subscriber and configuring Inbox authentication. Keep secret API keys on your backend.What are the core concepts?
These concepts work together within the selected environment:Organizations and environments
An organization groups your notification resources. Environments separate the workflows, subscribers, integrations, and credentials used for testing from those used for live delivery. Use an API key for the environment you intend to trigger. A provider configured in one environment does not make it available in another.Workflows and triggers
A workflow defines the steps for a notification. Channel steps deliver messages; action steps add behavior such as a delay, digest, throttle, or HTTP request. A trigger starts that workflow. In the REST request,name identifies the workflow, to identifies its recipients, and payload carries the event details used in templates and conditions. You can also attach context and other supported trigger options.
Subscribers and preferences
A subscriber represents a recipient in an environment. ItssubscriberId identifies the recipient, while fields such as email, phone, and provider credentials determine how external channels can reach them.
Subscriber data can also personalize a message. Preferences affect which channels should deliver according to the workflow’s configuration.
To notify a group, resolve the intended audience in your application and pass the subscriber IDs to the trigger API. The current guides do not rely on a topic-management API.
Channels and integrations
A channel is a delivery medium: in-app, email, SMS, push, or chat. An integration connects an external channel to a provider using credentials configured for that environment. An email step might use SendGrid or Resend, while an SMS step might use Twilio. In-app messages are stored for the subscriber’s Inbox instead of going through an external messaging provider.How does the full notification flow work?
1
Your application triggers a workflow
Your backend calls
POST /v1/events/trigger with the environment’s API key, the workflow identifier in name, recipients in to, and any event details in payload.For a lead-assignment notification, the payload could include the lead’s name and a link to the record. See Trigger a workflow for request examples.2
The recipient is resolved
WorldVisa resolves each subscriber in the current environment and uses the relevant profile data, channel details, and preferences for the run.
3
The configured steps execute
The workflow evaluates its steps in order. Conditions determine whether a step runs, templates use the available data to render content, and action steps apply the configured timing or logic.
4
Messages reach their channels
In-app steps create messages for the Inbox. External channel steps use the selected provider integration and recipient details to attempt delivery.A successful trigger response means the event was accepted for processing. It does not confirm that every provider has delivered its message.
5
You review the result
Open the Activity Feed to inspect the workflow run and its steps. Use the transaction ID to trace the event and review failures such as missing recipient details, invalid credentials, or provider errors.See Monitor and debug a workflow when you need to investigate delivery.
Explore core concepts
Understand events, notifications, and messages in more detail.
Build a workflow
Put the concepts together in the workflow editor.