Creating integration notifications for sync sessions

Create notifications to inform your colleagues of the status of sync sessions.

Creating the workflow

1. Click Configuration > Workflows.
2. Click Add (+) and select Integration Sync Sessions from the list. The Begin and End blocks are automatically added to the canvas.
3. Enter the name and a description of the workflow. 

Editing the Begin block

Specify the criteria to trigger the workflow.

1. Click Edit .
2. Add rules to trigger the workflow.
   1. Select New+Edit from the Actions list.
   2. In the Integration equals field, specify the name of the integration.
   3. In the Object equals field, specify the type of integration.
3. Click Save.

Important
Best practice is to select New + Edit in the Begin block. In some cases, a new integration when it is run starts with a status of Processing with no errors but fails as it progresses (which falls under the category of an Edit). In other cases, a new integration might fail immediately with an error (which falls under the category of New). Changing the Actions setting to New + Edit ensures that the workflow captures both scenarios.

Option 1: Sending notifications by email

Use the Notify block to alert your colleagues by email about the status of a sync session that has been completed. 

1. Click Blocks and drag and drop the Notify block onto the canvas.
2. Click Edit  .
3. On the Information tab, make the following changes:
   1. Enter the name of the Notify block.
   2. Deselect Notification so that you only receive an email notification.
   3. To provide a link to your Oomnitza workflow in the email, ensure that Include Link is selected.
4. On the Recipients page, enter the recipients of the email. You can choose to select recipients from defined Oomnitza fields, roles, or users. Alternatively, you can manually enter email addresses. For further information, refer to Using the Notify block. 
5. On the Message tab, create your message. Click Add Metadata to add metadata relating to the integration, such as the Status and number of Errors. 
6. Click Save.

Note
To configure the email header and footer, click Configuration > General > Global Settings. Change the key values for the email.header and email.footer. Learn more

Option 2: Using Slack to send notifications

The Slack Send Message preset sends a Slack message to the specified user or users.

Before you start

To use Slack to send notifications, your Slack OAuth credentials to Oomnitza need to be added to Oomnitza.

1. Click Blocks and drag and drop the API block onto the canvas.
2. Click Edit.
3. In the Search pane, enter Slack Send Message.
4. Click the arrow > to select the preset.
5. Select your Slack credentials from the list.
6. Enter your Channel ID or name. This is the channel where the Slack message is posted.
7. Enter a brief message, for example, Integration Alert.
8.  Click the Advanced Mode button located in the upper right of the window.
9. Select the Body tab. Click Add Metadata to add metadata relating to the integration, such as the Status and number of Errors. 
10. Click Save.

Launching the workflow

Connect the blocks. See the illustrations below.

Validate and Launch the workflow.

Testing the workflow

1. Navigate to the integration that you specified in the Begin block criteria.
2. Select Run Now.
3. Check the progress of your integration by selecting Sync Sessions.
4. As soon as your integration appears in the Sync Sessions list, a workflow is triggered. Click Configuration> Workflows and click the workflow that you added.
5. Click Run Logs .
6. Your workflow should appear in the latest run log. 
7. Depending on the option that you chose, check your email inbox or Slack messages.