Webhooks, integrations and log export API
This API covers Airgate’s outbound integrations: context servers (third-party systems Airgate talks to, such as Microsoft Intune, Jamf Pro, CrowdStrike Falcon, SentinelOne, Palo Alto Networks firewalls, ServiceNow or Splunk), context actions (HTTP requests run by HTTP enforcement profiles), signed webhooks for any event topic, and syslog / SIEM export. It backs Settings › Webhooks (the Webhooks and integrations page), Settings › Log export, and the device sources under Integrations.
Base path and permissions
Section titled “Base path and permissions”All routes are relative to /api/v1/t/{tenant}, where {tenant} is the tenant slug or ID. See API overview for authentication.
| Permission | Routes |
|---|---|
admin:read |
Every GET route on this page, except GET /context-actions/options. |
policy:read |
GET /context-actions/options (the action picker of the HTTP enforcement profile editor). |
admin:write |
Every POST, PUT and DELETE route, including test, sync, redeliver and bulk (they send traffic). |
Lists return {"items": [...], "total": N} and accept q, limit and offset (default limit 50, at most 1000).
Every change, test, sync and redelivery is written to the audit log (object types context_server, context_action, webhook, syslog_target); a context-action dry run is not. A bulk action records one audit entry per object.
Secrets
Section titled “Secrets”These fields are encrypted at rest and returned as "********": secret on context servers and webhooks, token on HEC syslog targets, and every header or parameter marked "sensitive": true. When you create or update an object:
- For
secretandtoken: leave the field out or send"********"to keep the stored value, send""to clear it, or send a new value to replace it. - For sensitive
headersandparamsentries: a value of"********"or""keeps the stored value of the same name; remove the entry to delete it. A stored sensitive entry stays sensitive unless you send a new value with it. - Stored credentials are bound to their destination. An update that moves the destination to another origin (scheme, host and port) while keeping a stored credential answers
400, for examplebase_url / token_url host changed: send the secret againorurl host changed: send the values of the sensitive headers again. Send the credential again with the new destination. Path-only changes and setting a destination for the first time are not moves. The webhook signingsecretis not bound, because it never leaves Airgate.
Outbound connection policy
Section titled “Outbound connection policy”Every outbound connection (actions, token requests, webhooks, syslog, HEC, device-sync APIs and User-ID) is checked against Airgate’s egress policy on the resolved address at connect time, redirects included. Link-local and cloud metadata addresses are always refused. Redirects are followed at most 3 times and only within the same origin (plus an http to https upgrade on the same host). A refused destination fails with destination address not allowed by egress policy: <ip> and is not retried. See Security hardening.
Common behaviour
Section titled “Common behaviour”Last test result and failing
Section titled “Last test result and failing”Context servers, context actions, webhooks and syslog targets store the outcome of their last test: last_test_at, last_test_ok (null = never tested), last_test_error, last_test_http_status (0 when not HTTP), last_test_latency_ms, last_test_detail.
failing (read-only) is true when the object is enabled and its most recent health signal failed:
| Object | Signals (newest wins) |
|---|---|
| Context server | Last test; for device-sync servers also the last sync. |
| Context action | Last test; the latest policy or integration run in the last 24 hours. |
| Webhook | Last test; the latest real delivery in the last 30 days (failed, or retrying after a failure). |
| Syslog target | Last test; the sender’s last error compared with its last successful send. |
Status filters
Section titled “Status filters”GET /context-servers, /context-actions, /webhooks and /syslog-targets accept these filters, combined with q:
| Query | Values |
|---|---|
enabled |
true, false |
placeholder |
true, false (context servers only) |
last_test_ok |
true, false, none (never tested) |
failing |
true, false |
An invalid value answers 400.
Bulk actions
Section titled “Bulk actions”POST /context-servers/bulk, POST /context-actions/bulk, POST /webhooks/bulk and POST /syslog-targets/bulk (admin:write):
| Field | Type | Meaning |
|---|---|---|
ids |
UUID[] | Objects to act on. Duplicates are ignored. |
action |
string | enable, disable (at most 500 IDs) or test (at most 50 IDs; 8 run in parallel within a 50-second budget). |
test |
object | Context actions only: the test body applied to every action. Without dry_run, real requests are sent. |
curl -s -X POST "$AIRGATE/api/v1/t/$TENANT/webhooks/bulk" \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -d '{"ids":["7c9e6679-7425-40de-944b-e07fc1f90ae7"],"action":"test"}'Response 200, one item per distinct ID in request order:
{"action": "test", "total": 2, "succeeded": 1, "failed": 1, "items": [ {"id": "…", "name": "SOAR", "ok": true, "result": {"…": "…"}}, {"id": "…", "ok": false, "code": "not_found", "error": "webhook not found"}]}code is not_found, bad_request, test_failed (the test ran; result holds it), timeout (the bulk budget ran out) or internal.
Context servers
Section titled “Context servers”| Route | Permission | Purpose |
|---|---|---|
GET /context-server-types |
admin:read |
Catalogue of server types. |
GET /context-servers |
admin:read |
List. q matches name, description and base_url; type filters. |
POST /context-servers |
admin:write |
Create. |
POST /context-servers/bulk |
admin:write |
Bulk enable, disable or test. |
GET /context-servers/{id} |
admin:read |
One server. |
PUT /context-servers/{id} |
admin:write |
Update. |
DELETE /context-servers/{id} |
admin:write |
Delete. |
POST /context-servers/{id}/test |
admin:write |
Test with the stored credentials. |
POST /context-servers/{id}/sync |
admin:write |
Run a device sync now. |
GET /context-servers/{id}/mdm-devices |
admin:read |
Devices the last syncs saw. |
GET /context-servers/{id}/references |
admin:read |
HTTP enforcement profiles that use the server. |
Context server object
Section titled “Context server object”{ "id": "1b0f7a1e-1d5c-4b8a-9d55-7c1d2a3b4c5d", "name": "ITSM", "description": "ServiceNow production", "type": "servicenow", "base_url": "https://contoso.service-now.com", "auth_type": "basic", "username": "svc-airgate", "secret": "********", "tls_verify": true, "ca_cert": "", "headers": [{"name": "X-Key", "value": "********", "sensitive": true}], "params": [], "config": {}, "timeout_sec": 10, "enabled": true, "placeholder": false, "last_test_ok": true, "failing": false, "action_count": 3, "created_at": "2026-11-19T07:59:00Z", "updated_at": "2026-11-19T08:00:00Z"}| Field | Meaning |
|---|---|
type |
generic (default), paloalto, panorama, fortinet, checkpoint, juniper_srx, infoblox, intune, jamf, crowdstrike, sentinelone, airwatch, mobileiron, maas360, afaria, introspect, servicenow, splunk. See GET /context-server-types. |
base_url |
http(s)://host[:port][/path], no user info. Required for paloalto, panorama, intune, jamf and splunk, for any auth_type other than none, and when a header or parameter is sensitive. Intune defaults to https://graph.microsoft.com, CrowdStrike to https://api.crowdstrike.com. |
auth_type |
none, basic (username + secret), bearer (secret is the token), api_key (secret is the key), oauth2_cc (username is the client ID, secret the client secret). Allowed values depend on the type. |
headers |
Sent with every request of the server’s actions that goes to base_url’s origin. Values may contain %{…} templates. |
params |
Values for bare %{name} references in action templates. A sensitive parameter is only sent to base_url’s origin. |
timeout_sec |
1–120, default 10. Per-attempt timeout for actions without their own. |
placeholder |
Marks an incomplete server created by an import. Any save without "placeholder": true clears it. |
action_count |
Context actions on this server. |
Credentials and server headers are only sent to the server’s own origin. An action whose final URL is on another origin is sent without them, and its result carries the warning request URL is not on the context server's base_url origin: server credentials and headers were not sent.
How each auth_type is applied:
auth_type |
Request |
|---|---|
basic |
Authorization: Basic. For paloalto / panorama, a PAN-OS API key is generated with the username and password (cached 12 hours) and sent as X-PAN-KEY. For jamf, a bearer token is obtained first. |
bearer |
Authorization: Bearer <secret>. |
api_key |
Header config.api_key_header (default X-API-Key; X-PAN-KEY for Palo Alto; Authorization for splunk) set to config.api_key_prefix + secret. |
oauth2_cc |
OAuth 2.0 client credentials against the token URL; the token is cached until shortly before it expires, and a 401 fetches a new one once. |
config keys (unknown keys are kept and ignored; booleans and integers are normalised, an unparsable value answers 400):
| Key | Types | Meaning |
|---|---|---|
test_path |
all | Path or absolute URL the test probes. Default: base_url. |
token_url, scope, oauth_auth_style |
oauth2_cc |
Token endpoint, scope, and header to send client credentials with HTTP Basic. |
azure_tenant_id, login_url |
intune |
Entra tenant ID; sign-in host (default https://login.microsoftonline.com). |
api_key_header, api_key_prefix |
api_key |
See above. |
mdm_sync, sync_interval_min |
intune, jamf, crowdstrike, sentinelone |
Turn the device sync on; interval 5–10080 minutes, default 60. |
zero_trust |
crowdstrike |
Also fetch Zero Trust Assessment scores. |
host_filter |
crowdstrike |
FQL filter for the host list, for example platform_name:'Windows'. |
agent_filter |
sentinelone |
Extra agent query filters, for example siteIds=123&isDecommissioned=false. |
include_computers, include_mobile |
jamf |
Inventories to poll (default both). |
allow_empty |
intune, jamf, crowdstrike |
Accept an empty inventory. Otherwise a sync that returns no devices while devices are known fails, to protect endpoint data. |
user_id |
paloalto, panorama |
Turn the User-ID integration on. |
user_id_domain |
paloalto, panorama |
DOMAIN\ prefix for user names without \ or @. |
user_id_timeout_min |
paloalto, panorama |
Login entry timeout, 0–10080 (0 = firewall default). |
user_id_register_roles |
paloalto, panorama |
Register the session roles as dynamic tags of the IP. |
user_id_interim |
paloalto, panorama |
Refresh the login on each session update. |
user_id_skip_mac |
paloalto, panorama |
Skip MAC-address user names (default true). |
vsys / target |
paloalto / panorama |
Virtual system, or managed firewall serial, for User-ID calls. |
GET /context-server-types
Section titled “GET /context-server-types”Permission: admin:read
{"items": [{"type": "intune", "label": "Microsoft Intune", "aliases": ["Microsoft Intune"], "auth_types": ["oauth2_cc"], "default_auth": "oauth2_cc", "default_base_url": "https://graph.microsoft.com", "mdm": true, "user_id": false, "config_keys": ["azure_tenant_id", "login_url", "token_url", "scope", "mdm_sync", "sync_interval_min"], "description": "Microsoft Graph deviceManagement/managedDevices (app registration with DeviceManagementManagedDevices.Read.All)."}], "total": 18}POST /context-servers
Section titled “POST /context-servers”Permission: admin:write
Defaults: type generic, auth_type the type’s default, tls_verify true, enabled true, timeout_sec 10. The name must be 1–128 characters and unique (409 otherwise). basic needs username; bearer and api_key need secret; oauth2_cc needs username, secret and a token URL; ca_cert must contain PEM certificates.
curl -s -X POST "$AIRGATE/api/v1/t/$TENANT/context-servers" \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -d '{"name":"Intune","type":"intune","auth_type":"oauth2_cc", "username":"<app client ID>","secret":"<client secret>", "config":{"azure_tenant_id":"<Entra tenant ID>","mdm_sync":true,"sync_interval_min":60}}'Response 201: the server.
PUT /context-servers/{id}
Section titled “PUT /context-servers/{id}”Permission: admin:write
Same body; name is required and other fields you leave out keep their values. Changing credentials drops cached tokens. Turning config.mdm_sync off, or changing the type, removes the endpoint attributes the server wrote (see Device sync). Response 200.
DELETE /context-servers/{id}
Section titled “DELETE /context-servers/{id}”Permission: admin:write
Response 204. 409 in_use while the server still has actions (context server still has actions: A, B) or an HTTP enforcement profile references it. Deleting a device-sync server removes the endpoint attributes it wrote.
POST /context-servers/{id}/test
Section titled “POST /context-servers/{id}/test”Permission: admin:write
Runs a type-specific probe with the stored credentials and stores the outcome:
| Type | Probe |
|---|---|
intune |
Microsoft Graph managed devices, first page. |
jamf |
Computers inventory, first page. |
crowdstrike |
Host list (the detail shows the host count). |
sentinelone |
Agent count. |
paloalto, panorama |
show system info (the detail shows host name, model and PAN-OS version). |
splunk |
HEC health endpoint. |
servicenow |
test_path, or the sys_user table with one row. |
| Others | GET {base_url}{test_path}: any answer except 401, 403 or 5xx is success. |
{"ok": true, "http_status": 200, "latency_ms": 84, "detail": "Microsoft Graph managedDevices reachable", "error": "", "at": "2026-11-19T08:00:00Z"}A test that is interrupted because the API request timed out stores nothing and answers 504 timeout.
POST /context-servers/{id}/sync
Section titled “POST /context-servers/{id}/sync”Permission: admin:write
Schedules a device sync now; it starts within 30 seconds. Response 202: the sync status. 400 for a type without device sync; 409 when the server is disabled or mdm_sync is off.
GET /context-servers/{id}/mdm-devices
Section titled “GET /context-servers/{id}/mdm-devices”Permission: admin:read
Devices the last syncs saw on this server. q matches MAC (any notation), device name, device ID or attribute values.
{"items": [{"mac": "00:11:22:33:44:55", "device_id": "d1", "device_name": "LAPTOP-1", "attributes": {"MDM Enabled": "true", "MDM Compliant": "true", "OS Version": "10.0.26100", "Model": "Latitude 7450"}, "first_seen_at": "2026-11-19T07:00:00Z", "last_seen_at": "2026-11-19T08:00:00Z", "written_at": "2026-11-19T07:00:00Z"}], "total": 1}GET /context-servers/{id}/references
Section titled “GET /context-servers/{id}/references”Permission: admin:read
HTTP enforcement profiles that use the server, sorted by profile name.
{"items": [ {"id": "…", "name": "Open ticket", "description": "", "action": "ACCEPT", "via": "context_action_id", "action_id": "5f2a…", "action_name": "Quarantine ticket"}, {"id": "…", "name": "Inline via ITSM", "description": "", "action": "ACCEPT", "via": "context_server_id"}], "total": 2}via is context_server_id (the profile overrides its server with this one), context_action_id (the profile runs one of the server’s actions) or attributes (the profile names one of the server’s actions by name).
Context actions
Section titled “Context actions”| Route | Permission | Purpose |
|---|---|---|
GET /context-actions |
admin:read |
List. q matches action and server name, description and URL; filters server_id, server_type. |
GET /context-actions/options |
policy:read |
Compact picker list (at most 1000). q, server_id. |
GET /context-actions/presets |
admin:read |
Built-in action templates. server_type filters. |
GET /context-actions/log |
admin:read |
Execution log. |
GET /context-actions/log/{logid} |
admin:read |
One log entry with request and response bodies. |
POST /context-actions |
admin:write |
Create. |
POST /context-actions/bulk |
admin:write |
Bulk enable, disable or test. |
GET /context-actions/{id} |
admin:read |
One action. |
PUT /context-actions/{id} |
admin:write |
Update. |
DELETE /context-actions/{id} |
admin:write |
Delete. |
POST /context-actions/{id}/test |
admin:write |
Run with a synthetic context. |
GET /context-actions/{id}/references |
admin:read |
HTTP enforcement profiles that run the action. |
Context action object
Section titled “Context action object”{ "id": "5f2a8c1e-3b7d-4e9a-8c6b-2d1e0f9a8b7c", "server_id": "1b0f7a1e-…", "server_name": "ITSM", "server_type": "servicenow", "name": "Quarantine ticket", "description": "", "action_type": "", "method": "POST", "url": "/api/now/table/incident", "content_type": "application/json", "body": "{\"short_description\":\"Airgate: %{Connection:Client-Mac-Address} placed in %{Tips:Role}\"}", "headers": [], "params": [{"name": "timeout", "value": "60", "sensitive": false}], "response_attributes": {"result.number": "ServiceNow Incident"}, "timeout_sec": 0, "retries": 2, "enabled": true, "references": ["Connection:Client-Mac-Address", "Tips:Role"], "last_test_ok": true, "last_run_at": "2026-11-19T08:31:02Z", "last_run_status": "success", "failing": false}| Field | Meaning |
|---|---|
server_id |
A context server of the tenant. Required. Action names are unique per server. |
method |
GET, POST (default), PUT, PATCH or DELETE. |
url |
An absolute http(s):// URL, a path relative to the server’s base_url, or a template starting with %{param} (the whole base URL from a parameter). {key} is replaced by the server’s key (only on the server’s origin). At most 8192 characters. |
content_type |
MIME type; JSON, XML, PLAIN and FORM are accepted as short forms. Default application/json. |
body |
Template, at most 1 MiB. |
response_attributes |
{"<JSON path>": "<endpoint attribute>"}: after a 2xx JSON answer, the values are written to the endpoint of the request. Paths: a.b, $.a.b, a[0].b, a[*].b, ['key.with.dots']. |
timeout_sec |
0–120; 0 uses the server’s timeout. |
retries |
0–5, default 2. Extra attempts after a network error, 408, 429 or 5xx (backoff 1, 2, 4 seconds, at most 8). Other 4xx answers and egress refusals are final. |
references |
Read-only: the %{…} references used. |
last_run_at, last_run_status |
Latest policy or integration run: success, failed or skipped. |
Templates
Section titled “Templates”Values in url, body, headers and params are expanded from the sign-in context with the same %{Namespace:Attribute} syntax as enforcement profiles (for example %{Radius:IETF:User-Name}, %{Connection:Client-Mac-Address-NoDelim}, %{Tips:Role}). An unresolved reference becomes "" and is listed in unresolved. Credential attributes are never available to templates: passwords, MS-CHAP responses, MPPE keys and any attribute whose name contains password, secret, psk, api_key, private_key or credential are removed first.
Each value is encoded for where it lands: one path segment before ? in a URL, a query value after it, JSON escaping in a JSON body, XML escaping in an XML body, form encoding in a form body, and raw in headers and other bodies.
Bare %{name} references resolve from the action’s params, then the server’s params, then these built-ins:
| Parameter | Source |
|---|---|
ip, IPADDRESS, ip-address, user_ip |
Client IP address. |
user, name, username |
User name. |
full-username |
Full user name. |
mac, MACADDRESS |
Client MAC address. |
machine, hostname |
Endpoint host name. |
DEVICECATEGORY, category |
Endpoint category. |
role, roles |
Session roles. |
posture |
Posture token. |
nas-ip, nad-ip |
Network device address. |
ssid |
SSID. |
domain |
Domain of DOMAIN\user, or the realm of user@realm. |
requestid |
A random UUID per run. |
Sensitive values, API keys and tokens are masked as ******** in logs, test results and alerts.
POST /context-actions
Section titled “POST /context-actions”Permission: admin:write
curl -s -X POST "$AIRGATE/api/v1/t/$TENANT/context-actions" \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -d '{"server_id":"1b0f7a1e-…","name":"Teams notify","method":"POST", "url":"%{hook_url}","content_type":"JSON", "body":"{\"text\": \"%{Authentication:Username} connected %{Connection:Client-Mac-Address}\"}", "params":[{"name":"hook_url","value":"https://contoso.webhook.office.com/…","sensitive":true}]}'Response 201: the action. On PUT, name is required and other fields you leave out keep their values. DELETE answers 204, or 409 in_use when an HTTP enforcement profile references the action.
POST /context-actions/{id}/test
Section titled “POST /context-actions/{id}/test”Permission: admin:write
Runs the action with a synthetic context, even when the action is disabled (a disabled server makes it skipped). All fields are optional.
| Field | Type | Meaning |
|---|---|---|
mac |
string | Client MAC; also loads the endpoint unless skip_endpoint is true. |
username |
string | User name. |
ip |
string | Client IP. |
ctx |
object | Extra attributes: namespace → name → values, for example {"Tips": {"Role": ["Employee"]}}. |
params |
object | Override action parameters. |
dry_run |
boolean | Render only: nothing is sent or logged; status is rendered. |
skip_endpoint |
boolean | Do not load the endpoint. |
{ "log_id": 1842, "status": "success", "http_status": 201, "attempts": 1, "latency_ms": 212, "error": "", "unresolved": ["Tips:Posture"], "warnings": [], "request": {"method": "POST", "url": "https://contoso.service-now.com/api/now/table/incident", "headers": {"Content-Type": "application/json", "X-Key": "********"}, "body": "{\"short_description\":\"Airgate: aa:bb:cc:dd:ee:ff placed in Employee\"}"}, "response_body": "{\"result\":{\"number\":\"INC0010001\"}}", "attributes": {"ServiceNow Incident": "INC0010001"}}status is success (2xx; for Palo Alto also an XML status="success"), failed, skipped or rendered. response_body is cut at 4 KiB. A real (not dry-run) test is stored in last_test_*.
GET /context-actions/log
Section titled “GET /context-actions/log”Permission: admin:read
Policy, integration and test runs, newest first. Retained 30 days.
| Query | Meaning |
|---|---|
action_id, server_id, profile_id |
Only these. |
status |
success, failed or skipped. |
source |
policy, integration or test. |
from, to |
RFC 3339, YYYY-MM-DD, YYYY-MM-DDTHH:MM or Unix seconds or milliseconds. |
q |
Action, server or profile name, MAC, username or error text. |
{"items": [{ "id": 1842, "at": "2026-11-19T08:31:02.12Z", "source": "policy", "action_id": "5f2a…", "action_name": "Quarantine ticket", "server_id": "1b0f…", "server_name": "ITSM", "profile_id": "0d6a…", "profile_name": "Open ticket", "record_id": "6f0c…", "mac": "aa:bb:cc:dd:ee:ff", "username": "alice@contoso.com", "method": "POST", "url": "https://contoso.service-now.com/api/now/table/incident", "status": "success", "http_status": 201, "attempts": 1, "latency_ms": 212, "error": "", "unresolved": []}], "total": 1}record_id is the Sign-in log record that triggered the run. User-ID runs have action_id: null and action_name User-ID login or User-ID logout. GET /context-actions/log/{logid} returns one entry plus request_body (masked, at most 8 KiB), response_body (masked, at most 4 KiB) and attributes.
GET /context-actions/presets
Section titled “GET /context-actions/presets”Permission: admin:read
Built-in templates: slack-message, teams-message, pan-login, pan-logout, pan-register-role, fortinet-login, fortinet-logout, checkpoint-add-identity, checkpoint-delete-identity, servicenow-incident, splunk-hec-event. Each item has key, name, server_type, action_type, description, method, url, content_type, body, headers, params and response_attributes.
HTTP enforcement profiles
Section titled “HTTP enforcement profiles”An HTTP enforcement profile in an access policy runs, after the sign-in decision, either a context action (config.context_action_id, optionally on another server with config.context_server_id), an inline request (config.url with method, headers, body, content_type, response_attributes), or an action named by the Target Server and Action attributes. config.timeout_sec (1–120) and config.retries (0–5) override the action’s values. Every run writes one execution log entry with source policy. Runs are queued per tenant and never delay the RADIUS answer. See the Policy administration API.
Webhooks
Section titled “Webhooks”| Route | Permission | Purpose |
|---|---|---|
GET /webhook-topics |
admin:read |
Topic catalogue. |
GET /webhooks |
admin:read |
List. q matches name, description and URL. |
POST /webhooks |
admin:write |
Create. |
POST /webhooks/bulk |
admin:write |
Bulk enable, disable or test. |
GET /webhooks/{id} |
admin:read |
One webhook. |
PUT /webhooks/{id} |
admin:write |
Update. |
DELETE /webhooks/{id} |
admin:write |
Delete (with its deliveries). |
POST /webhooks/{id}/test |
admin:write |
Send a test event now. |
GET /webhooks/{id}/deliveries |
admin:read |
Delivery log. |
GET /webhooks/{id}/deliveries/{did} |
admin:read |
One delivery with bodies. |
POST /webhooks/{id}/deliveries/{did}/redeliver |
admin:write |
Send a delivery again. |
Webhook object
Section titled “Webhook object”| Field | Type | Meaning |
|---|---|---|
name |
string | Required. |
description |
string | Free text. |
url |
string | Where events are posted. |
topics |
string[] | At least one: exact topics, prefix.* or *. |
secret |
string | HMAC-SHA256 signing key; "" = unsigned. |
headers |
array | Extra headers {"name", "value", "sensitive"}. |
tls_verify, ca_cert |
boolean, string | Server certificate verification. |
timeout_sec |
integer | 1–60, default 10. |
max_retries |
integer | 0–10, default 5. |
enabled |
boolean | Default true. |
Read-only: last_delivery_at, last_delivery_status, pending, failed_24h, delivered_24h (real deliveries only; tests and redeliveries are not counted), last_test_*, failing.
curl -s -X POST "$AIRGATE/api/v1/t/$TENANT/webhooks" \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -d '{"name":"SOAR","url":"https://soar.contoso.com/hooks/airgate", "topics":["auth.*","posture.changed"],"secret":"<signing secret>","max_retries":5}'Response 201: the webhook (with secret masked). On PUT, name is required; other fields you leave out keep their values.
Topics
Section titled “Topics”GET /webhook-topics returns {"items": [{"topic", "description"}], "total": N}:
| Topic | Description |
|---|---|
auth.accept |
RADIUS / web authentication accepted |
auth.reject |
RADIUS / web authentication rejected |
tacacs.authen |
TACACS+ authentication |
tacacs.author |
TACACS+ command / session authorization |
tacacs.acct |
TACACS+ accounting |
session.start |
Network session started (accounting) |
session.update |
Network session interim update |
session.stop |
Network session stopped |
endpoint.created |
Endpoint first seen / created |
endpoint.updated |
Endpoint attributes changed |
endpoint.profile_changed |
Endpoint device profile changed |
endpoint.deleted |
Endpoint deleted |
endpoint.bulk |
Bulk endpoint action / import / cleanup |
posture.changed |
Endpoint posture token changed |
guest.created |
Guest account created |
guest.approved |
Guest account approved by a sponsor |
guest.expired |
Guest account expired |
guest.login |
Guest portal login |
cert.issued |
Certificate issued |
cert.revoked |
Certificate revoked |
coa.sent |
CoA / Disconnect sent |
config.changed |
Configuration object changed |
system.alert |
System alert |
nad.problem |
Network device problem (unknown device, wrong shared secret) |
admin.audit |
Administrator audit record |
Delivery format
Section titled “Delivery format”Airgate sends POST {url} with these headers:
Content-Type: application/jsonUser-Agent: NAC-Cloud-NAC-Webhook/1.0X-NAC-Event: auth.acceptX-NAC-Delivery: <delivery id>X-NAC-Timestamp: 1795000000X-NAC-Signature: sha256=<hex HMAC-SHA256(secret, "<X-NAC-Timestamp>.<raw body>")>X-NAC-Signature is present only when the webhook has a secret. Your configured headers follow.
{"id": "3e0b8f8e-7a42-4cfa-9f0e-5c2f1a0d7b61", "topic": "auth.accept", "time": "2026-11-19T08:31:02.120931Z", "tenant_id": "9eac1cf6-…", "tenant": "contoso", "data": {"record_id": "6f0c…", "username": "alice@contoso.com", "mac": "aa:bb:cc:dd:ee:ff", "roles": ["[Employee]"]}}idis the event ID. It stays the same across retries and redeliveries; use it to remove duplicates.- Credential fields in
dataare masked as********at any depth. - Verify the signature with your secret and reject timestamps older than a few minutes.
A 2xx answer is success. Network errors, 408, 429 and 5xx are retried with exponential backoff (30 seconds, 1 minute, 2 minutes, up to 1 hour, with jitter) up to max_retries; other 4xx answers fail at once. A delivery that finally fails raises a system.alert. Pending deliveries survive restarts. Deliveries are kept 30 days.
Delivery log
Section titled “Delivery log”GET /webhooks/{id}/deliveries lists deliveries newest first. Filters: status (pending, success, failed), topic (prefix), manual (true for tests and redeliveries).
{"items": [{"id": "0a3c…", "webhook_id": "7c9e…", "event_id": "3e0b…", "topic": "auth.accept", "status": "pending", "manual": false, "attempts": 2, "http_status": 503, "error": "HTTP 503", "latency_ms": 31, "created_at": "2026-11-19T08:31:02Z", "last_attempt_at": "2026-11-19T08:31:33Z", "next_attempt_at": "2026-11-19T08:32:35Z", "delivered_at": null}], "total": 1}GET /webhooks/{id}/deliveries/{did} adds body (the JSON posted) and response_body (at most 2 KiB).
POST /webhooks/{id}/deliveries/{did}/redeliver posts the stored body again as a new manual delivery, without automatic retries, and returns it.
POST /webhooks/{id}/test sends a webhook.test event at once (a manual delivery, no retries) with data {"message": "Test delivery from Airgate", "webhook": "<name>"}, stores the outcome in last_test_* and returns the delivery.
Syslog and SIEM export
Section titled “Syslog and SIEM export”| Route | Permission | Purpose |
|---|---|---|
GET /syslog-targets |
admin:read |
List. q matches name, host and URL. |
POST /syslog-targets |
admin:write |
Create. |
POST /syslog-targets/bulk |
admin:write |
Bulk enable, disable or test. |
GET /syslog-targets/{id} |
admin:read |
One target. |
PUT /syslog-targets/{id} |
admin:write |
Update. |
DELETE /syslog-targets/{id} |
admin:write |
Delete. |
POST /syslog-targets/{id}/test |
admin:write |
Send one test message. |
Syslog target object
Section titled “Syslog target object”| Field | Meaning |
|---|---|
name, description |
Label. name is required. |
protocol |
udp (default), tcp, tls (RFC 5425) or hec (Splunk HTTP Event Collector). |
host, port |
For udp, tcp, tls: host name or IP; port default 514 (6514 for tls). |
url, token |
For hec: base URL (/services/collector/event is added unless the URL already contains /services/collector) and the HEC token. |
format |
rfc5424 (default), cef, leef or json. |
topics |
Patterns as for webhooks. [] uses the default set: auth.*, tacacs.*, session.start, session.stop, admin.audit, system.alert, coa.sent, posture.changed, endpoint.profile_changed, guest.*, cert.*. |
facility |
0–23, default 16 (local0). |
app_name |
RFC 5424 APP-NAME, 1–48 printable ASCII characters without spaces. |
tls_verify, ca_cert |
Server verification for tls and hec. |
config |
framing: octet (RFC 6587 octet counting, default) or lf for tcp and tls; syslog_header (default true): false sends CEF, LEEF or JSON without the RFC 5424 header; for hec: index, sourcetype, source. |
status |
Read-only: the sender’s queue depth, counters since start and last error, for the Airgate instance that answered. |
curl -s -X POST "$AIRGATE/api/v1/t/$TENANT/syslog-targets" \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -d '{"name":"Splunk","protocol":"hec","url":"https://splunk.contoso.com:8088", "token":"<HEC token>","format":"json","topics":["auth.*","admin.audit"], "config":{"index":"airgate","sourcetype":"airgate:json"}}'Response 201. Changes reach every Airgate instance within 15 seconds.
Severity: auth.reject, failed TACACS+, CoA NAK or timeout, posture QUARANTINE or INFECTED and system.alert warnings are warning (4); system.alert errors are err (3); admin.audit, config.changed, cert.revoked and endpoint.deleted are notice (5); everything else is info (6).
Message examples:
rfc5424 <132>1 2026-11-19T08:30:12.123456Z <host> <app_name> - auth.reject [nac@32473 tenant="contoso" username="alice" mac="aa:bb:cc:dd:ee:ff" nad_ip="10.0.0.2" result="REJECT" reason="bad password"] Authentication REJECT …cef … CEF:0|NAC Console|Cloud NAC|1.0|auth.reject|RADIUS / web authentication rejected|6|… cs1Label=tenant cs1=contoso suser=alice smac=aa:bb:cc:dd:ee:ff …leef … LEEF:2.0|NAC Console|Cloud NAC|1.0|auth.reject|^|devTime=…^cat=auth.reject^usrName=alice^srcMAC=aa:bb:cc:dd:ee:ff^…json … {"time":"…","event_id":"…","topic":"auth.reject","tenant":"contoso","severity":"warning","message":"…","data":{…}}CEF custom strings: cs1 tenant, cs2 service, cs3 roles, cs4 profiles, cs5 posture. Payloads are masked like webhook data. UDP messages are cut at 8 KiB. HEC events are sent in batches of up to 100 events or 1 second, with 3 attempts per batch. TCP and TLS targets reconnect with backoff (1 second to 1 minute); while disconnected, up to 10 000 messages per target are queued, then dropped and counted. A failing target raises a system.alert.
POST /syslog-targets/{id}/test
Section titled “POST /syslog-targets/{id}/test”Permission: admin:write
Sends one syslog.test message over a new connection, also for disabled targets, and stores the outcome. For UDP, success only means the datagram was sent.
{"ok": true, "http_status": 0, "latency_ms": 12, "detail": "sent over TLS", "error": "", "at": "2026-11-19T08:00:00Z"}Integrations
Section titled “Integrations”Device sync
Section titled “Device sync”Servers of type intune, jamf, crowdstrike or sentinelone with config.mdm_sync set are synchronised every sync_interval_min minutes (after a failure, the next try is within 15 minutes). Each reported MAC address becomes an endpoint (created Unknown when new) with attributes such as MDM Enabled, MDM Compliant, Compliance, MDM Identifier, MDM Device Name, OS, OS Version, Model, Manufacturer, Serial Number, Owner, Encryption Enabled, Last Check In and MDM Source. Intune devices also get Intune * attributes (for example Intune Managed, Intune Compliance State, Intune Azure AD Device Id); CrowdStrike hosts get CrowdStrike * attributes (for example CrowdStrike System Found, CrowdStrike Status, and with zero_trust the CrowdStrike Assessment * scores); SentinelOne agents get SentinelOne * attributes (for example SentinelOne System Found, SentinelOne Infected, SentinelOne Network Status).
- Only devices whose attributes changed are written.
- Devices no longer reported get
MDM EnabledandMDM Compliantfalse(Intune alsoIntune Managedfalse; CrowdStrike onlyCrowdStrike System Foundfalse; SentinelOne onlySentinelOne System Foundfalse). - When two devices report the same MAC, the one with the latest check-in wins.
When a sync server is deleted, or its sync is turned off, Airgate removes the attributes it wrote, in the background. An attribute that an administrator or another source has changed since is kept; a value another sync server reports for the same device is restored. Disabling the server only pauses the sync; the attributes stay.
Sync status object
Section titled “Sync status object”{"server_id": "1b0f…", "server_name": "Intune", "type": "intune", "enabled": true, "interval_min": 60, "status": "success", "last_run_at": "2026-11-19T08:00:00Z", "last_success_at": "2026-11-19T08:00:04Z", "next_run_at": "2026-11-19T09:00:04Z", "devices": 1520, "endpoints_updated": 12, "endpoints_removed": 1, "duration_ms": 4180, "error": "", "cleanup_pending": 0}status is idle (never ran), running, success or failed.
Palo Alto User-ID
Section titled “Palo Alto User-ID”For every enabled paloalto or panorama server with config.user_id, session events produce PAN-OS User-ID calls: a login on session.start (with the session roles registered as dynamic IP tags when user_id_register_roles is set), a refreshed login on session.update when user_id_interim is set, and a logout on session.stop. Sessions without an IP address are skipped, and so are MAC-address user names unless user_id_skip_mac is false. Calls for the same server and IP are applied in event order, logged in the execution log with source integration, and retried twice.
GET /integrations
Section titled “GET /integrations”Permission: admin:read
Status of every integration of the tenant.
{ "palo_alto_user_id": [{"server_id": "…", "server_name": "fw1", "type": "paloalto", "base_url": "https://fw1.contoso.com", "enabled": true, "last_success_at": "…", "last_error_at": null, "last_error": "", "sent_24h": 840, "failed_24h": 0}], "mdm": [{"server_id": "…", "server_name": "Intune", "type": "intune", "status": "success", "devices": 1520, "…": "…"}], "context_actions": {"executed_24h": 912, "succeeded_24h": 905, "failed_24h": 5, "skipped_24h": 2, "queue": {"queued": 0, "in_flight": 1, "dropped": 0}}, "webhooks": {"total": 2, "enabled": 2, "pending": 0, "delivered_24h": 4100, "failed_24h": 0, "queue": {"queued": 0, "in_flight": 0, "dropped": 0}}, "syslog": [{"target_id": "…", "name": "QRadar", "protocol": "tls", "format": "leef", "enabled": true, "status": {"…": "…"}}], "mdm_cleanup_pending": 0, "node": "…", "cache_age_sec": 7}Context-action counts exclude test runs; webhook counts exclude tests and redeliveries. queue, syslog[].status, node and cache_age_sec describe the Airgate instance that answered.
System alerts
Section titled “System alerts”Integration problems are published as system.alert events (shown in Monitor › Alerts and events, and sent to webhooks and syslog), at most once per tenant and key every 10 minutes:
| Key | When |
|---|---|
action:<action name> |
A policy or integration run of the action failed. |
profile:<profile name> |
An HTTP enforcement profile could not run (missing, not HTTP, unresolvable). |
action-queue-full |
An HTTP profile or User-ID job was dropped because the tenant’s queue was full. |
webhook-queue:<webhook id> |
A webhook event was dropped because the tenant’s delivery queue was full. |
webhook:<webhook id> |
A delivery finally failed. |
syslog:<target id> |
A syslog or HEC target failed to connect, write or post. |
mdm:<server id> |
A device sync failed. |