The following tutorial demonstrates how to send your logs to Coralogix using UpGuard. Follow this five-step guide for each notification that you would like to send us.
UpGuard uses webhooks to send notifications when an event happens in your UpGuard account. This could be when an identity breach or data leak is detected, the score of a watched vendor drops below a certain threshold, or when a user requests access to your shared profile.
STEP 1. Create Integration.
STEP 2. Select Triggers
STEP 3. Name and Destination
Coralogix Cluster URL | API Endpoint |
.com | https://api.coralogix.com |
.us | https://api.coralogix.us |
.in | https://api.app.coralogix.in |
.app.eu2.coralogix.com | https://api.eu2.coralogix.com |
.app.coralogixsg.com | https://api.coralogixsg.com |
Schema Endpoint Details | |
Webhook URL | https://api.<clusterURL>/api/v1/logs |
Content-Type | application/json |
For example, if your Coralogix data is hosted in India, your webhook URL should appear as https://api.app.coralogix.in/api/v1/logs.
Example:
STEP 4. Define Payload Structure
POST Body
Required | Property Name | Property Type | Note |
Yes | privateKey | UUID | |
Yes | applicationName | string | usually used to separate environments |
Yes | subsystemName | string | usually used to separate components |
computerName | string | ||
Yes | logEntries | array of logs |
Log
Required | Property Name | Property Type | Notes |
Yes | timestamp | number | UTC milliseconds since 1970 (supports sub millisecond via a floating point) |
Yes | severity | number | 1 – Debug, 2 – Verbose, 3 – Info, 4 – Warn, 5 – Error, 6 – Critical |
Yes | text | string |
{ "privateKey": "<Coralogix send your data api-key>", "applicationName": "<application name>", "subsystemName": "<subsytem name>", "computerName": "<computer name>", "logEntries": [ { "severity": <default severity of event 1-6>, "text": { "notification": { } } } ] }
{ "privateKey": "xxxxxxx-xxxxxx-xxxxxx-xxxxxxx", "applicationName": "upguard", "subsystemName": "upguard", "computerName": "upguard01", "logEntries": [ { "severity": 4, "text": { "notification": { "id": {{ notification.id }}, "type": "{{ notification.type }}", "description": "{{ notification.description }}", "occurredAt": "{{ notification.occurredAt }}", "context": { "PrevScore": {{ notification.context.PrevScore }}, "PrevScoreOn": "{{ notification.context.PrevScoreOn }}", "Threshold": {{ notification.context.Threshold }}, "LatestScore": {{ notification.context.LatestScore }}, "LatestScoreOn": "{{ notification.context.LatestScoreOn }}" } } } } ] }
Example:
STEP 5. Enable the Integration
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].