Skip to content
Nappai Documentation

Notify

The Notify component lets you create a notification that can be read by the Get Notified component in your Nappai dashboard. It’s a simple way to pass a message or piece of data to another part of your workflow without any external calls.

How it Works

When you drop the Notify component into a flow, you give it a Name (the title of the notification), some Data (the content you want to store), and decide whether to Append the data to an existing record or replace it. Internally, the component checks the type of the data you provide:

  • If it’s a string, it’s stored as plain text.
  • If it’s a dictionary, it’s stored as structured data.
  • For any other type, it’s converted to a string.

The component then either updates the existing notification record or appends to it, and returns the data so you can use it later in the workflow.

Inputs

  • Name: The title of the notification. This helps you identify the notification later.
  • Data: The information you want to store. It can be a simple text message, a dictionary of values, or any other data type that can be converted to text.
  • Append: If you tick this box, the new data will be added to the existing notification record instead of replacing it. Leave it unchecked to overwrite the previous content.

All three fields are available in every use of the component.

Outputs

The component outputs a Data object that contains the notification content. You can feed this output into other components, such as the Get Notified component, to display or process the notification later in your workflow.

Usage Example

  1. Drag the Notify component onto the canvas.
  2. Set Name to “Order Update”.
  3. Set Data to a dictionary like { "order_id": 1234, "status": "shipped" }.
  4. Leave Append unchecked (so the notification replaces any previous “Order Update” record).
  5. Connect the output of this component to the Get Notified component to display the message to users.

If you want to keep a history of updates, check Append so each new message is added to the existing record.

  • Get Notified – Reads the notification created by Notify and displays it to users.
  • Log – Stores the notification data in a log file for audit purposes.
  • Email – Sends the notification content via email to a list of recipients.

Tips and Best Practices

  • Use a clear and unique Name so you can easily find the notification later.
  • If you need to keep a running log of changes, enable Append.
  • Keep the Data concise; large payloads can slow down the workflow.
  • Combine Notify with a Condition component to send notifications only when certain criteria are met.

Security Considerations

  • The Notify component stores data locally within the Nappai system; it does not send data to external services.
  • Be mindful of sensitive information: if the notification contains personal data, ensure it is handled according to your organization’s privacy policies.
  • Use the Get Notified component to control who can view the notification, limiting access to authorized users only.