Getting started
Webhook alerts send a POST request to your specified URL and pass a JSON composed with 3 groups of data:
    Alert properties (alert_name, ...)
      These fields are directly returned in the top level of the json
    Event properties (technology_name, ...)
      These fields are nested in a json under the "event_properties" key
    Company properties (employees_range, ...)
      These fields are nested in a json under the "company_properties" key
A typical JSON payload for a webhook alert set through Sonar is as follow:
1
{
2
"event_id": 458325,
3
"timestamp": "2020-04-23T12:25:32.209Z",
4
"type": "technology_removed",
5
"alert_name": "Hotjar deleted",
6
"event_verbose": "Wine Central removed Hotjar",
7
"domain": "winecentral.co.nz",
8
"event_properties": {
9
"technology_name": "Hotjar",
10
"technology_domain": "https://www.hotjar.com/",
11
"technology_category": "Analytics"
12
},
13
"company_properties": {
14
"company_name": "Wine Central",
15
"alexa_rank": null,
16
"country": "New Zealand",
17
"location": "Albany, Auckland, New Zealand",
18
"industry": "Food & Beverages",
19
"employees_range": "1-10",
20
"social_linkedin_url": "linkedin.com/company/wine-central",
21
"social_facebook_url": "/4winecentral",
22
"social_twitter_url": null,
23
"year_founded": 2013
24
}
25
}
Copied!
All keys are sent, with a null object returned when the data is not available.
Company properties have been added to all events to allow greater flexibility in the way you can use the alerts in your workflows. You can for example automatically send that information to an outbound tool with the right data like the name of the company as a parameter.
Last modified 1yr ago
Copy link