Skip to main content
Version: Latest (4.62.0)

Notifications

The notification accelerator flows let you send selected messages to email, Telegram, or Slack. They do not read stored Console logs. Instead, their Subscribe components listen for messages published by any flow in the same project.

Publish notifications​

  1. Add a notificationTopic variable to the project environment. All notification flows use %notificationTopic% by default.
  2. In each flow that should send notifications, add a Publish component at every point where a relevant log is produced and set the topic to %notificationTopic%.
  3. Define the value you want to send to the Publish component. This can be the same value that is connected to a Logger component. This can be of any type.
  4. Turn on each notification flow that should receive messages. Subscribe components only receive messages while their flow is turned on.

Email with Resend​

  1. In the Resend Domains dashboard, add a domain that you own.
  2. Add the DNS records shown by Resend at your DNS provider and wait until the domain is verified.
  3. Create an API key in the Resend API Keys dashboard and store it securely.
  4. Configure the Email (Resend) flow variables:
    • apiKey: the Resend API key. By default, it uses the %resendApiKey% project environment variable. Please store the API key in a project environment variable instead of hardcoding it in the flow.
    • domain: the verified domain. Email is sent from notifications@<domain>. E.g. example.com . - recipient: the destination email address. E.g. recipient@example2.com.
    • topic: the topic used by the publishing flow. This should be the same topic as the one used by the Publish components. It is recommended to use the %notificationTopic% project environment variable.

See the Resend domain documentation for more information.

Telegram​

  1. Open BotFather, run /newbot, and follow the prompts to create a bot and receive its token.
  2. Open a private chat with the bot and send it a message, or add it to the destination group and send a message there.
  3. Set the Telegram flow's token variable. By default, it uses the %telegramToken% project environment variable. Please store the token in a project environment variable instead of hardcoding it in the flow.
  4. Run the Get Chat ID section. Copy the ID shown for the destination chat.
  5. Configure the remaining flow variables:
    • chatId: the destination chat ID.
    • topic: the topic used by the publishing flow. This should be the same topic as the one used by the Publish components. It is recommended to use the %notificationTopic% project environment variable.

Keep the token secret. See the Telegram bot documentation for more information.

Slack​

  1. Create a Slack app and select the workspace that contains the destination channel.
  2. Open Incoming Webhooks in the app settings and enable Activate Incoming Webhooks.
  3. Select Add New Webhook to Workspace, choose the destination channel, and authorize the app.
  4. Copy the generated webhook URL and configure the Slack flow variables:
    • webhookUrl: the incoming webhook URL. By default, it uses the %slackWebhookUrl% project environment variable. Please store the webhook URL in a project environment variable instead of hardcoding it in the flow.
    • topic: the topic used by the publishing flow. This should be the same topic as the one used by the Publish components. It is recommended to use the %notificationTopic% project environment variable.

The webhook URL is a secret and is tied to the selected channel. See the Slack incoming webhooks documentation for more information.

Heartbeat​

In most migration scenarios, the migration is performed on a migration server instead of your own machine. It may occur that this server receives an unsolicited reboot. The optional Heartbeat flow publishes a message on a schedule. It can be used to confirm that your migration server is still running. Whenever Xill4 reboots, flows are not automatically restarted. If you stop receiving heartbeat messages, it may indicate that the migration server has rebooted and the flows have to be restarted. Use this flow in combination with one or more of the notification flows to receive heartbeat notifications.

  1. Set the Heartbeat flow's topic variable. It uses %notificationTopic% by default.
  2. Open the Code component with the Configure Interval note and set either everyMinutes or everyHours to a positive value. Set the unused value to 0.
  3. As opposed to the notification flows, the Heartbeat flow needs to be turned on and triggered in order to start publishing messages. It will continue to publish messages until the flow is turned off even though it seems like it's in an idle state.