In this walk-through, we'll create a Zapier integration that automatically logs the name and outcome (SUCCESS/FAILED) of each Botium test session to a Google Sheet.
Configuration
First, we'll create an API Key in Botium and set up a formatted Google Sheet.
- In Botium, go to
Botium Tools & Settings > Settings > Users & Permissions / API Keys
- Create an API Key named “Zapier”
- Define the API Key's validity period.
- Select the following permissions:
- TESTSESSIONS_SELECT
- TESTSESSIONS_REPORTS
- TESTPROJECTS_SELECT
- Click the SAVE button, and copy the content of the “API Key”
field.Note: The API key will be visible in the upper right of the window once the configuration has been save:
- Next, create a Google Sheet as described here: https://help.zapier.com/hc/en-us/articles/8496276985101#make-sure-the-first-row-is-a-header-row-with-column-names-0-0
Connection
Now we can connect Zapier to Botium, so that when a test session completes, the Google Sheet is updated.
- Login to Zapier and open the My Apps menu
-
Click on “+ Add connection”, search for “Botium” and enter your Botium credentials:
- For the “Botium URL” enter the URL you are using in your browser to access Botium
- For the API Key, enter the API Key from Botium
- Afterwards, you will see Botium in the list of apps. You can perform a
connection test with the “...” menu, and selecting “Test connection”
- Click the Add Connection button to also connect your Google Sheets account.
- Now, click on the big + Create ZAP button.
- Choose "Botium" as the App, then select "Test Session and Test Results" as
the Event.
- In Account, select the one we created before.
- In the Trigger settings, select the Botium Test Project to track, then apply
the Test Session and Test Result filter.
- To finish the configuration, select “Test trigger” to ensure Zapier is
properly linked with Botium.
Note: It will show one test session Zapier finds in your Botium.
- The Botium part is now ready to go. Next, in the Action section, select Google Sheets and connect to the Sheet you created earlier. Set the Event to "Create Spreadsheet Row."
- Assign the Botium test session fields to the corresponding columns in the
Google Sheet as detailed below.
- Test it and then click on Publish to activate the Zap.
Running the Zapier Integration
Now that the Zap is published, we can run a test session in Botium for the Test
Project you selected for this Zap.
Follow this sequence to confirm that Zap is working as expected:
- Ensure the Zap is published.
- Open Botium and select the Test Project associated with this Zap.
- In Zapier, find your Zap and click the “...” menu.
- Select “Run” from the menu.
- Wait a few seconds for confirmation that a new row has been added to your Google Sheet.