Batch completion notifications - Slack integration

The Eyes Batch completion notifications feature gives you the option of automatically receiving Slack messages that inform you when batches you are running have successfully finished or failed. You can receive these notifications whether your tests are executed manually or by a build executed through a CI tool. The notifications contain a summary of the test completion status and quality, and include a link to the Test manager where you can review the test results in detail.

Use the Slack section on a Team's Integrations tab to configure Batch completion notifications via Slack. In the Slack section you can:

• Enable or disable Slack notifications.
• Specify the Slack channels to which you want to send notifications for each application.
• Specify the applications, branches, and/or batches for which you want to receive notifications via Slack.
• Specify the batch completion status that prompts Eyes to send Batch completion notifications.

Configuring the slack integration

note

You need to be a team admin or account admin to configure notifications.

Accessing the Slack notification page

Admins integrate Slack with Eyes to support posting Eyes Batch completion notifications via Slack workspaces and channels. You access and configure the feature via the Integrations tab on the Team's page. To access the Slack notifications page:

1. Click the Admin entry in the Test Manager Page Navigator. The Admin entry only appears in the Page Navigator for users who have admin permissions.

2. Click the Teams tile and then in the list of teams click the team for which you want to add Slack.

3. Click the Integrations tab and then click Slack.

   

Adding Slack workspaces and channels

You can connect Eyes to Slack by adding a workspace/channel section to the list of workspaces in the Slack section.

To add Batch completion notifications with Slack:

1. Access the Slack Integration section.

2. Add a new Slack channel by clicking Add to Slack.

   • If you have the correct permissions, you are redirected to the Slack.com authorization page from which you can choose the Slack workspace and channel to be used for publishing notifications.
   • If you do not have the correct permissions or if you are not allowed to install apps, then Slack displays its standard Not Authorized to install error message.

   

   • Click Message one of your admins to request authorization to install apps.

Configuring notifications for Slack channels

You can configure Slack workspaces/channels to send Eyes Batch completion notifications:

• For all apps or specific apps that a team works on.
• For all branches or a specific branch
• For all batches or only batches with a specific property and value
• Any time a batch finishes or in response to a specific batch termination state.

To configure Slack notifications:

1. Change the Slack notification settings as needed. See the setting descriptions in the table below.
2. Click Save changes.

Settings for posting notifications via Slack

Setting	Option	Description
Send notifications for	A. All apps B. Select application C. All branches D. Select branch E. All Batches F. select batch (requires a custom property that you can provide ID and value for)	A. Default. Choose to send notifications for all applications. B. Select specific application for which to send notifications. C. Default. Choose to send notifications for all branches. D. Select specific branch for which to send notifications. E. Default. Choose to send notifications for all batches F. Select specific batch for which to send notifications
Notify me	A. Only when a batch completes with an Unresolved status or a failure B. Every time a batch completes	A. Default. Only sends Batch completion notifications when a batch completes with an Unresolved status or a failure B. Sends Batch completion notifications whenever a batch completes

Disabling notifications for Slack channels

You can disable Slack connections to temporarily prevent Eyes from sending Batch completion notifications to team members. This action is applied to all of the listed applications and associated workspace/channel pairs. To disable Slack connections:

• Open the Slack section on the Integrations tab.
• Click Enabled and set the option to the Off position.
• Click Save changes.

Deleting notifications for Slack channels

Deleting a workspace/channel pair removes it from the Slack section permanently. This can only be undone by reconnecting the workspace/channel pair. If you delete the only workspace/channel pair present in the Slack section, the section closes and appears as disabled, with a gray circle located next to Slack title in the section. To re-enable the option, you will need to recreate a connection to the Slack workspace/channel pairs.

Note: Disabling Slack notifications prevents notifications being sent temporarily. Notifications can be re-enabled without the need to recreate a connection to the Slack workspace/channel pairs. To delete a Slack workspace/channel connection:

• Open the Slack section on the Integrations tab and locate the workspace/channel pair that you want to delete.

• Click the X in the right-hand corner of the connection's title bar.

  

• Click Save changes.

Configuring the SDK

Notifications are triggered once the BatchInfo object is marked as closed. Depending on the SDK in use, you may need to close the batch via an API in the code or it will be handled for you. See below for instructions on how to configure your selected SDK:

Configuring Notifications in CI/CD or Distributed Environments

When running tests through CI/CD, it is common to run parallel jobs and test executions to speed up test suites. As mentioned above, Batch Notifications are only sent once the BatchInfo object for your test suite has been closed. If you're running parallel jobs, you must ensure that the Batch is closed only after every job completes otherwise you'll get incorrect notifications.

See this article under the Batching section for instructions on how to handle batch close logic in distributed test runs.