Notifiers

In this article: 

• Overview
  • Accessing Enhanced Flow Notifications
  • Types of Notifications
• Email Notifications
• Webhook Notifications
• Negative Result Monitoring
  
   

Overview

Enhanced Flow Notifications allow you to stay informed of the status of your Flow executions. You can add multiple notifiers to each Flow and select the type of Flow status that will trigger a particular notification. Add your email address or others’ to receive an automatic email notification based on conditions you specify. You can also add webhook notifications to send a real-time Flow execution status update to another application. Finally, you can set a negative result monitor notification for increased specificity regarding when the system should check for the Flow status and deliver a notification.

For more information on Enhanced Flow Notifications customization, watch our Enhanced Flow Notifications Overview video. 

Accessing Enhanced Flow Notifications 

Follow the steps below to navigate to Enhanced Flow Notifications. To access Enhanced Flow Notifications, first sign in to your Chain.io portal account at https://portal.chain.io/. 

1. At the top menu bar, click Workspaces and select the desired Workspace. 

2. At the top menu bar, click Integrations and select the desired Integration. 

If you have not previously created an Integration, click the blue Add New text to create a new Integration. For more information on how to create a new Integration, refer to our Integrations support article.   

3. At the top right of the window, click the hamburger menu and select Integration Settings. 

4. Click Edit on the right side of the row to open the configuration settings for the specific Flow.
    

If you have an existing Flow, it will appear within the table near the top of the page. Otherwise, create a new Flow by clicking the blue Add New Flow button. For more information on how to create a new Flow, refer to our Creating A Basic Flow support article.
 

4. Scroll down to the Notifications subsection and click the banner to expand.
   
   The Notifications subsection offers email notifications and Webhook notifications. There is also the option to include negative result monitoring.
    

Remember to click Save and then click Deploy within the menu on the right side of the page upon completing notifications updates. This step is listed in the instructions below for each type of notification; however, if you complete multiple edits within the Flow settings page, this step is only required once at the end. 

Types of Notifications 

For email and webhook notifications, you can subscribe to one or more of the following three Flow execution statuses. 

• Success - Flows that complete in the "Success" status and have been fully processed. 
• Skipped - Flows that began processing and intentionally reached a skipped status.  This can happen if the data in the Flow isn't relevant.  For example, you may have logic in the flow that only processes ocean shipments and skips all air shipments.
• Error - Flows that finish in either "Error" or "Technical Error" status. 

For more information on Flow statuses, refer to the Flow Status & Errors support article. 

 

Email Notifications

The email notifications feature allows you to receive an email notification if the Flow execution result matches the specified parameters. 

In order for the email notification to be sent, the following two conditions must be met:

• The Flow execution results must match one of the selected Flow result trigger statuses (e.g. success, skipped, or error).
• The Flow execution results must match all of the selected trigger conditions.
   

To add an email notification: 

1. Click the blue Add A Notifier button to add a recipient for the email notification. 

A pop-up window will appear with details for the email notification.

2. Add specifications for the email notification.
    
   • Recipients: Enter the recipient’s email address. If you want to receive notifications for the Flow status, enter your email address. You can also provide the email address of another member of your team who is responsible for monitoring the Flow status or responding to issues in the Flow execution process.
     
     
     
      
   • Flow Result Triggers: Select one or more of the following statuses for which you would like the email notification to generate. success, skipped, and error.
     
     
     
      
   • Trigger Conditions (Optional): Select from “log message contains”, ”data tag name equals”, and “data tag value equals”.
     
     
     
      
   • Customize Email (Optional): Enter the subject that the user will see for the email notification. If left empty, the email will generate a default subject line.
     
     
     
     
     Enter the body of text that the user will see for the email notification. If left empty, the email will generate a default message.
     
     
     
     
     You can add a data tag to further customize the message. Including the data tag will result in the value corresponding to the data tag being displayed in the finalized email notification message in place of the data tag text. The data tag format is:
      
   • Include Additional Information: Make a selection to include additional information in the email notification if desired. You can choose to include the execution file names or log content. Information generated from these selections will be sent as file attachments with the email notification message.
     
     
     
      
3. Click the blue Update Notifier button at the bottom of the Edit Notifier pop-up window to add the email notification recipient to the list of notifiers.

4. Make updates to the email notifications settings if necessary.
   • To edit a notifier, click the pencil icon on the right of the row.
   • To delete a notifier, click the trash can on the right of the row.
   • Click the blue Add A Notifier button at the bottom of thiis section to add another recipient. 

5. Within the menu on the right side of the page, click Save to secure the email notifications settings.
    

6. Within the menu on the right side of the page, click Deploy to implement the settings updates in the Flow.
   
    

Webhook Notifications

The webhook notifications feature allows you to receive a webhook notification if the Flow execution result matches at least one of the selected statuses and all of the specified conditions. A license is required to add webhook notifications. For assistance with altering your license option, contact your Customer Success Manager or send us an email at accounting@chain.io.
 

In order for the webhook notification to be sent, the following two conditions must be met:

• The Flow execution results must match one of the selected Flow result trigger statuses (e.g. success, skipped, or error).
• The Flow execution results must match all of the selected trigger conditions. 

To add a webhook notification: 

1. Click the blue Add A Notifier button.
   
   
   
   
   A pop-up window will appear with details for the email notification.
   
   
    
2. Add specifications for the webhook notification.
    
   • Web Address: Enter the URL at which you would like to receive webhook notifications.
     
     
     
      
   • API Key: Enter the API Key required for authentication.
     
     
     
      
   • Flow Result Triggers: Select one or more of the following statuses for which you would like the webhook notification to generate: success, skipped, and error.
     
     
      
   • Trigger Conditions: Select one or more of the following statuses for which you would like the webhook notification to generate: success, skipped, and error. Select from “log message contains”,” data tag name equals”, and “data tag value equals”.
     
     
     
      
   • Include Additional Information: Make a selection to include additional information in the webhook notification if desired. You can choose to include the execution file names. If you choose to include the execution file names with the webhook notification, the files will be added to the JSON object as an array titled “file_names.” The array will produce a JSON and an XML file.
     
     
     
      
3. Click the blue Add Notifier button at the bottom of the Add Notifier pop-up window to add web address to the list of webhook notifiers.
    
4. Make updates to the webhook notifications settings if necessary.
   • To edit a notifier, click the pencil icon on the right of the row.
   • To delete a notifier, click the trash can on the right of the row.
   • Click the blue Add A Notifier button at the bottom of this section to add another web address.
      
5. Within the menu on the right side of the page, click Save to secure the webhook notifications settings.
    

6. Within the menu on the right side of the page, click Deploy to implement the webhook notifications settings updates in the Flow.

For more information on webhook formats, visit this article.
 

Negative Result Monitoring 

The negative result monitoring feature allows you to receive a notification if the Flow does or does not run during a specified timeframe. This provides additional feedback about the stability of the Flow execution. 

To add negative result monitoring:
 

1. Click the blue Add A Monitor button. 

2. Specify the time interval at which the monitor should be automatically checked.

3. Set the parameters for triggering the monitor.
    

4. Set the time frame during which the monitor should automatically provide feedback about the Flow’s status.
    

5. Click the blue Add Monitor button on the bottom right of the pop-up window to add the monitor to the list of notification settings.
    
6. Within the menu on the right side of the page, click Save to secure the negative result monitoring settings.
    
7. Within the menu on the right side of the page, click Deploy to implement the negative result monitoring settings updates in the Flow.