Squadcast Support

API

Send events to Squadcast using an API

You can use our API integration to send alerts to Squadcast in HTTP POST format.

Notice for API:

APIv2 is the new version of our alert source API. This also carries the option to resolve through the API call.

API will soon be deprecated in favour of APIv2 but is currently still functional.

Please use APIv2 from the Integration Type dropdown for any new alert source API integrations and not API. If you are using the old API, please migrate it to the latest API (APIv2) and update your Webhook URLs.

To know more about APIv2, refer to this documentation.

Getting Alerts Into Squadcast Using API

  • Open Services and create a new service
  • Select integration type as API to get your API integration key
  • Enter Service Name and Service Description then Save to create the service

  • Use the Webhook URL to send a HTTP POST request

For example:
https://api.squadcast.com/v1/incidents/create/d3c3208e86b787faf2ec01c154ed024081dc0fda

Please make sure that the request header is "Content-type":"application/json"

The body of the POST request should contains the details of your incidents in the following format:

{
   "message":"This will be the incident message",
   "description": "This will be the incident description"
}

Add a Tag From Incident JSON

This section will give you an understanding of how you can add tags to an incidents straight from the Incident JSON using our API.

Typical Incident JSON:

{
   "message":"This will be the incident message",
   "description": "This will be the incident description",
   "tags": {
     "tagname1":"Tag value#1",
     "tagname2":"Tag value#2",
     "tagname3": {
       "color": "Valid HTML HEX Colour Notation goes here",
       "value":"Tag value#3"
     }
   }
}

Example Tagging Rules

Using Tags to Set Severity:

{
  	"message": "Error rates higher than usual",
    "description": "HTTP Error rates for srv_90 is above 90 counts/hour",
    "tags": {
    	"severity": "high"
    }
}

Note:

If a colour code isn't explicitly mentioned, then the system takes the default colour "#808080" for the tag

Assigning Colours to Tags:

{
	"message": "Error rates higher than usual",
  "description": "HTTP Error rates for srv_90 is above 90 counts/hour",
	"severity": {
  	"colour": "#FF0000",
  	"value":"backend"
  }
}

Different ways of tagging incident:

{
	"message": "Error rates higher than usual",
  "description": "HTTP Error rates for srv_90 is above 90 counts/hour",
	"tags" : {
   	"severity": "high",
	  "impact_level": 5,
   	"classification": {
    	"color":"#FF0000",
     	"value":"backend"
     }
 	}
 }

Updated 6 days ago

API


Send events to Squadcast using an API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.