Skip to content

Commit 2d18deb

Browse files
v1sheshhcursoragent
v1sheshh
and
cursoragent
committed
feat: add webhook & syslog data-forwarding integration docs
Port integration data-forwarding documentation (webhook, syslog, syslog-audit) from quilrai/docs#21. Nest under platform-areas/integrations (converted integrations.md to folder index), add TOCItems theme override, webhook sample-payload accordion styles, and BarChart2 sidebar icon. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e39f000 commit 2d18deb

12 files changed

Lines changed: 1205 additions & 8 deletions

File tree

‎docs/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ AI Gateway includes LLM Gateway and MCP Gateway.
107107

108108
Browser Extension and Endpoint Agent settings cover deployment, deployment management, deployment status, whitelisting, detection configuration, DLP actions, and browser monitoring behavior.
109109

110-
### [Integrations](./platform-areas/integrations.md)
110+
### [Integrations](./platform-areas/integrations/index.md)
111111

112112
Integrations help connect QuilrAI to identity providers, device management systems, SaaS platforms, cloud services, and AI services. The current platform includes connected and available connector views, instance configuration, and integration documentation for Okta, Jamf, ChatGPT, and AWS.
113113

‎docs/platform-areas/browser-extension.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ depend on forced login and background tab reading.
4949

5050
- [Findings](./findings.md)
5151
- [Endpoint Agent](./endpoint-agent.md)
52-
- [Integrations](./integrations.md)
52+
- [Integrations](./integrations/index.md)
5353
- [Audit Log And Exports](./audit-log-and-exports.md)
5454

5555
## Access Requirements

‎docs/platform-areas/integrations/_category_.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "Integrations",
3+
"position": 12,
4+
"link": {
5+
"type": "doc",
6+
"id": "platform-areas/integrations/index"
7+
},
8+
"customProps": {
9+
"icon": "Plug"
10+
}
11+
}

‎docs/platform-areas/integrations/data-forwarding/_category_.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "Data Forwarding",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Payload contracts and field-level schemas for Quilr's outbound data delivery channels."
7+
},
8+
"customProps": {
9+
"icon": "ClipboardList"
10+
}
11+
}

‎docs/platform-areas/integrations/data-forwarding/syslog-audit.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
sidebar_position: 3
3+
sidebar_label: Syslog Audit
4+
sidebar_custom_props:
5+
icon: ClipboardList
6+
---
7+
8+
# Syslog Audit
9+
10+
Forwards audit log events to your syslog server. Supports optional filtering to control which audit events are delivered.
11+
12+
## Setup
13+
14+
1. Go to **Integrations** and open the **Available** tab.
15+
2. Click **+ Add** on the **Syslog Audit** tile.
16+
3. Fill in the connection parameters:
17+
18+
| Field | Required | Description |
19+
|-------|----------|-------------|
20+
| Syslog Server IP/Domain | Yes | IP address or hostname of your syslog server |
21+
| Syslog Server Port | Yes | Port your syslog server listens on |
22+
| Protocol | Yes | Transport protocol: `TCP`, `UDP`, or `TLS` |
23+
| Message Format | No | `RFC 5424` (default) or `RFC 3164` |
24+
| Facility | No | Syslog facility to use for outgoing messages |
25+
| Forwarding Scope | Yes | `Send All Audits` forwards every audit event. `Send Filtered Audits` activates the user condition filter below. |
26+
27+
4. If you selected **Send Filtered Audits**, use **Configure user condition** to add filter rules that control which audit events are forwarded.
28+
5. Click **Save**.
29+
30+
## Payload
31+
32+
Messages are delivered using the selected wire format. RFC 5424 example:
33+
34+
```
35+
<142>1 2024-01-15T10:30:00Z hostname quilr-siem-service - - - {json_body}
36+
```
37+
38+
The JSON body contains the audit log event:
39+
40+
```json
41+
{
42+
"event_source": "quilr-audit",
43+
"event": {
44+
"trace_id": "uuid-v4",
45+
"subscriber": "subscriber-id",
46+
"tenant": "acme-corp",
47+
"service_name": "quilr-entities-service",
48+
"event_code": "USR-001",
49+
"task": "CREATE_USER",
50+
"category": "USER_MANAGEMENT",
51+
"resource_type": "USER",
52+
"resource": "user@acme.com",
53+
"status": "SUCCESS",
54+
"log_level": "INFO",
55+
"actioned_by": "admin@acme.com",
56+
"actioned_at": "2024-01-15T10:30:00.000Z",
57+
"extra_info": {},
58+
"error_info": {}
59+
}
60+
}
61+
```

‎docs/platform-areas/integrations/data-forwarding/syslog.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
sidebar_position: 2
3+
sidebar_label: Syslog
4+
sidebar_custom_props:
5+
icon: Activity
6+
---
7+
8+
# Syslog
9+
10+
Forwards the Extension findings to your syslog server based on the controls configured.
11+
12+
## Setup
13+
14+
1. Go to **Integrations** and open the **Available** tab.
15+
2. Click **+ Add** on the **Syslog** tile.
16+
3. Fill in the connection parameters:
17+
18+
| Field | Required | Description |
19+
|-------|----------|-------------|
20+
| Syslog Server IP/Domain | Yes | IP address or hostname of your syslog server |
21+
| Syslog Server Port | Yes | Port your syslog server listens on |
22+
| Protocol | Yes | Transport protocol: `TCP`, `UDP`, or `TLS` |
23+
| Message Format | No | `RFC 5424` (default) or `RFC 3164` |
24+
| Facility | No | Syslog facility to use for outgoing messages |
25+
26+
4. Click **Allow**.
27+
28+
## Payload
29+
30+
Messages are delivered using the selected wire format. RFC 5424 example:
31+
32+
```
33+
<134>1 2024-01-15T10:30:00Z hostname quilr-siem-service - - - {json_body}
34+
```
35+
36+
The JSON body contains the raw finding with browser and endpoint context:
37+
38+
```json
39+
{
40+
"event_source": "quilr-alert",
41+
"event": {
42+
"id": "uuid",
43+
"tenant": "acme-corp",
44+
"subscriber": "subscriber-id",
45+
"subProduct": "browser extension",
46+
"timestamp": 1705312200000,
47+
"data": {
48+
"user": {
49+
"username": "jdoe",
50+
"accountname": "jdoe@acme.com",
51+
"machinename": 24371751139089044,
52+
"email_label": "PRIMARY"
53+
},
54+
"browser": {
55+
"name": "Google Chrome",
56+
"version": "138.0.7204.101",
57+
"os": "macOS:14.6.0"
58+
},
59+
"application": {
60+
"name": "ChatGPT",
61+
"url": "https://chat.openai.com"
62+
},
63+
"check": {
64+
"id": "CID_101",
65+
"name": "data_leak_prevention",
66+
"properties": {
67+
"control": "sensitive-data-prevention",
68+
"context_id": "ctx-abc-123",
69+
"mode": "Allow_Original_Prompt_With_Mandatory_Justification",
70+
"alert_type": "finding",
71+
"alert_status": "open",
72+
"action_name": "BLOCK",
73+
"detections_original": [ "..." ],
74+
"detections_final": [ "..." ]
75+
}
76+
}
77+
}
78+
}
79+
}
80+
```

0 commit comments

Comments
 (0)