How to set up the Siteimprove Zapier integration

Modified on: Mon, 30 Aug, 2021 at 8:07 PM

Note: Currently the Siteimprove Zapier integration is in Beta release.

Zapier is an online automation tool that allows your favorite applications to work together.

For example, using Siteimprove’s Zapier Integration you can receive an email each time a broken link is discovered or create a Zendesk ticket automatically for each new misspelling found.

For a list of applications you can make connections with using Zapier visit the Apps that work with Zapier page of the Zapier website. 

In order to integrate Siteimprove with Zapier, you will need a Zapier account. You can sign up for free via the Zapier website.

This article will guide you on how to set up the Zapier integration and how to create your first "Zap" in combination with Siteimprove.

Currently the Siteimprove Zapier integration supports the Policy and QA modules only. For a list of the available triggers or data points that can be used with Zapier see the List of Siteimprove triggers available using Zapier Integration.

Preparation

  • Make sure you have a Siteimprove API Username and key to use in later steps for authentication. If you are new to the API please read "How to connect to the Siteimprove API" which has instructions on creating a key. Note: The data available in the Zapier is based on the permission and role of the API user.
  • Log in to your Zapier account.
  • Click on this Siteimprove Zapier invitation link and select "Accept invite and build a Zap".

Create a Zap

This example goes over how to setup a Zap for the trigger “Quality Assurance – New broken link” with the web application Slack. You can use similar steps to setup other Siteimprove triggers and different web applications.

 

Setup Trigger

A trigger is an event that starts a Zap. Once you’ve set up a Zap, Zapier will monitor for that trigger event.

  • Click the “Create Zap” button.
  • Select Edit (pencil icon) next to "Name your zap" and enter a unique name for your Zap.
    • It is recommended that you name your Zap something you remember and will be able to locate later on in case you need to make edits. For example "Quality Assurance - New Broken link - Siteimprove to Slack"
      Zap-name.png
  • Find the Siteimprove app using the search field.
  • Select the Siteimprove app. 
    Zap-trigger2.png
  • Select a trigger from the list of Siteimprove triggers presented.
  • Use the search field to find a specific trigger.
    • For this example, we will use “Quality Assurance – New broken link” trigger
  • Click “Continue”.
    Zap-listoftriggers2.png
  • Under "Choose account"
    Choose-Account.png
    • If already signed into your Siteimprove account with the API key select your Siteimprove Account.
    • If you have not signed into your Siteimprove account with the API key select "Sign in to Siteimprove (1.0.1)"
      Fill_in_your_Siteimprove_API_details
      • A modal view will appear, fill in your Siteimprove API details.
        • Username is your Siteimprove account email ( or API User Name)
        • Password is your API key
      • Click “Yes, Continue “
  • Select 'Continue'.
  • Select a site from your Siteimprove Account.
  • Click on ‘Continue’.
    Choose-Site.png
  • Select the "Test Trigger" button which will search from recent trigger events (broken links) to be selected to be used for testing the Zap.Test-Trigger.png
  • Pick a sample to test your Zapier setup.Test-Event.png
  • Select 'Continue'.

Setup Action

After you set up your Zap trigger, the next step is to add an action to your Zap. An action is an event your Zap performs when your trigger event occurs.

  • Under the "Action" section under "App Event" choose what app you want to perform an action with. 
    • In this example we'll use Slack so choose Slack from the possible applications.
      Choose-App-for-Action.png
  • Choose the "Action Event" option “Send Direct message”.
    • Typically there will be a description of what each "Action Event" does below it. 
  • Select "Continue".
    Action-Event.png
  • Connect your account
    • If you already have an account connected to Zapier for the action app, select it from the account menu.
    • If not, click "Connect a new account" and follow the instructions to connect your app to Zapier.
    • Select "Continue".
  • Authorize in Slack
    • If you are already logged in, you will get a message to authorize Zapier in Slack.
    • If not logged in you will have to log in first and then authorize Zapier in Slack.
    • You may also have to request approval from the App manager if the permissions are restricted. 
  • Click “Continue”
  •  

Customize the Action 

There should be options to customize or setup what is sent using the action. The options may differ for each web app. In this example we are using Slack.

Customize-Action.png

  • Fill out required fields. You can also fill out optional fields as needed. There will typically be a description of what the field does under it. 
    • Under "Send Multi Message" you can select to send to multiple users or not. (optional)
    • Fill in the ‘To Username’ with the desired user(s) that will receive automatic updates. (required)
    • Customize your "Message text" and choose that it is sent as a bot. (required)
      • By selecting from the  on the "Insert Data" area, found in the "Message text" field. You can add preset data that is retrieved from the Siteimprove API, for example, a time-stamp or URL.
    • You can customize the "Bot Name". The default is "Zapier." (optional)
    • You can select "Schedule At" to schedule the message to be sent out at a specified date / time. (optional)
  • Click on ‘Continue’.

Test your zap

After customizing your Zap you can now test it if you wish.

2021-07-29_15-04-28.png

You have the option with the next step to:

  • Select "Skip Test" to skip. This will enable the Zap without testing. 
  • Select "Test & Review". 
  • Select "Test & Continue". 

Both "Test & Review" and "Test & Continue" seem to send a test message and allow you to review the settings and modify them before you have the option to enable the Zap to finalize it. 

Test-Review.png

    • If the test was successful you should receive a slack message with a broken link sample and it will say that the test was successful in Zapier. 
    • If it was not successful you should receive a message in Zapier and you can review the setup and resend another test using the "Retest action" button under the "Test" section. 
    • To finalize the Zap select "Turn on Zap".

Once you have turned on the Zap you should have the ability to toggle it on and off from that page or from the Zaps page. 

Toggle.png

Managing or Editing your Zaps

You can also manage your Zaps from the Zaps page. You have the option there to edit the zaps, remove them and a host of other options. 

ZapsList.png

In App Guides and Zapier Help Center

Zapier has an in app guide to help you with these steps if you get stuck and a Help Center with useful documentation to help as well. 

 

This concludes the guide on how to setup the Zapier integration and how to create a Zap in combination with Siteimprove.

Note: Siteimprove is happy to help with questions regarding configuring the integration. Siteimprove does not provide support or product help for the third-party software with which you are connecting.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.