Runscope Integration Guide for API Monitoring

Pointers

• The integration is between a TaskCall service and Runscope.
• This integration only receives alerts in TaskCall from Runscope.
• TaskCall will automatically identify alerts that are the same and group them together into one incident.
• Incidents will automatically resolve when a Runscope test succeeds.

In TaskCall

1. Go to Configurations > Integrations and click New Integration.
2. Select the Runscope integration.
3. Give the integration a name and configure how incidents will be created. Only the Default Service field is required. The rest are optional.
4. Incidents (Optional)
   1. TaskCall automatically maps incoming payloads with internal attributes to create incidents. However, this can be customized in the Incidents tab. Constant values can be included alongside placeholders to dictate which attributes should map to the Incident Title, Description, Tags, Snapshots and Vendor URL. To insert a placeholder use double curly braces.
      
      
      
      For example, if you enter {{ alert.title }} in the Incident Title field, TaskCall will look for an attribute called "title" nested inside another attribute called "alert" in the incoming payload. If the nested attribute exists, its corresponding value will be pulled from the payload and inserted. If the nested attribute does not resolve successfully, TaskCall will fall back to the default mapping.
      
      If you are unsure, please leave the fields empty. TaskCall will use the default mapping to create the incident for you.
   2. Select the Urgency level the incident should be created at.
   3. Select the option to Group similar alerts together if you would like follow up triggers from the same alert source to be grouped into the same incident. If you leave this option unchecked, then a new incident will be created for every trigger. (This behavior is specific to new triggers; not updates to an alert.)
   4. Click Next to move on to the Services tab.
5. Services (Required)
   1. Select the Default Service incidents should be sent to. To route incidents to different services instead, set Map With Attribute to the attribute to route by using a placeholder. Then, map each value it can take to the service that should receive it.
      
      For example, to route by a region attribute sent in the payload, set Map With Attribute to {{ region }}, then map US to one service and EU to another, and so on.
      
      
   2. Click Next to move on to the Authorization tab.
6. Authorization (Optional)
   1. The Authorization tab allows a Bearer Token and an IP Allowlist be added if you would like to restrict who is able to send alerts to this integration. If you are unsure, this can be skipped.
7. Once done, click Save.
8. Copy the Integration Url that is issued for the integration. This will be used to set up the notification in Runscope.

In Runscope

1. Go to your team's Connected Services page. Alternatively, you can also navigate to Shared Environments > Add Shared Environment > Integrations .
   
   
   
   
2. Scroll down and find the Webhooks integration. Click Connect.
   
   
   
   
3. Give it a description. Preferrably name it TaskCall. Select the threshold when alerts should be sent out (at every run or every failure or when a test succeeds after failing). Paste the Integration Url you copied over from TaskCall in the URL field.
   
   
   
   
4. Click Save Changes.
.
5. Then make sure you enable the TaskCall integration you just created in your shared environments.
   
   
   
   
6. Done! You are ready to receive test results from Runscope.