Webhooks
The Webhooks page (page header Webhooks and integrations) is where Airgate talks to other systems over HTTP. You define context servers (firewalls, MDMs, ITSM, chat and SIEM endpoints) and the HTTP actions that HTTP enforcement profiles call, send signed event webhooks to any receiver, and check the health of the Palo Alto User-ID and MDM integrations.
What this page shows
Section titled “What this page shows”Settings › Administration › Webhooks has five tabs. The selected tab is kept in the address (?tab=), so you can link to it.
| Tab | Shows |
|---|---|
| Context servers | The external HTTP servers Airgate calls, with their type, authentication and last connection test. |
| Context actions | The HTTP requests (method, URL, body template) defined on those servers, which HTTP enforcement profiles reference. |
| Execution log | Every context action run by policy, by the User-ID integration or by a test. Kept for 30 days. |
| Webhooks | Event webhooks: JSON POST deliveries for selected event topics, with their delivery log. |
| Integrations | Live status of Palo Alto User-ID, MDM synchronisation, queues, webhooks and syslog targets on the replica serving the page. |
Fields and columns
Section titled “Fields and columns”Context servers tab
Section titled “Context servers tab”Stat tiles at the top (Servers, Disabled, Failing, MDM servers, Firewalls, Placeholders) filter the list when selected. The toolbar has a search box (Name, URL, username…) and an All types filter.
| Column | Meaning |
|---|---|
| Name | Server name and description. A Placeholder badge marks an imported server that is not complete yet. |
| Type | Server type, for example Generic HTTP, Palo Alto Networks Firewall, Microsoft Intune. |
| Base URL | The server’s base URL. |
| Auth | None, Basic, Bearer, API key or OAuth2. no secret appears when a secret is required but not stored. |
| Actions | Number of context actions on the server. |
| Last test | Result and time of the last Test connection. |
| Status | Enabled or Disabled, plus a failing badge if the last test or MDM sync failed. |
Add context server first asks you to pick a server type. The available types are Generic HTTP, Palo Alto Networks Firewall, Palo Alto Networks Panorama, Fortinet, Check Point, Juniper Networks SRX, Infoblox, Microsoft Intune, Jamf Pro, CrowdStrike Falcon, SentinelOne, VMware Workspace ONE (AirWatch), MobileIron / Ivanti, IBM MaaS360, SAP Afaria, Aruba IntroSpect, ServiceNow and Splunk HEC. Types marked MDM poll a device inventory; types marked User-ID send logins to a firewall.
Server form fields:
| Field | Meaning |
|---|---|
| Name | Required, up to 128 characters. |
| Server type | The type; changing it applies that type’s default base URL and authentication. |
| Description | Free text. |
| Base URL | http:// or https:// URL. Relative action URLs are joined to it, and credentials and server headers are sent only to its origin. Required for MDM, User-ID and Splunk servers, and whenever credentials or sensitive headers or parameters are set. Do not put credentials in the URL. If you change the host of a saved server, you must enter the secret and sensitive header values again. |
| Authentication | None, Basic / user + password, Bearer token, API key or OAuth2 client credentials, limited to what the type supports. |
| Timeout per attempt (s) | 1 to 120 seconds, default 10. Used by actions without their own timeout. |
| Username / Client ID | For Basic and OAuth2. For Palo Alto with Basic, an API key is generated with type=keygen and cached for 12 hours. |
| Password / Bearer token / API key / Client secret | The secret. Stored values are masked; leave the mask to keep the stored value. |
| Token URL, Scope, Client authentication | OAuth2 only. Client authentication is Form body (default) or HTTP Basic header. |
| API key header, API key prefix | API key only. Defaults: X-PAN-KEY for Palo Alto, Authorization with prefix Splunk for Splunk, otherwise X-API-Key. |
| Entra (Azure AD) tenant ID, Login URL | Microsoft Intune only. The token URL is derived from the tenant ID. |
| Synchronise devices (MDM poller) | MDM types. Turning it off removes the attributes this server wrote from the endpoints; disabling the server only pauses the sync. |
| Sync interval (minutes) | MDM types. 5 to 10080, default 60. |
| Poll computers, Poll mobile devices | Jamf Pro only. On by default. |
| Accept an empty inventory | MDM types. |
| Palo Alto User-ID (login / logout on session start / stop) | Palo Alto types. Turns on User-ID for this firewall. |
| User-ID domain | Prefixes DOMAIN\ to user names that contain neither \ nor @, for example CORP. |
| Login timeout (minutes) | 0 to 10080; 0 uses the firewall default. |
| Register roles as dynamic IP tags, Refresh login on interim updates, Skip MAC-address user names (MAB) | User-ID options. Skip MAC-address user names is on by default. |
| vsys, Target firewall serial | Palo Alto: virtual system (for example vsys1); Panorama: the managed firewall’s serial. |
| Server headers | Name, value and Sensitive flag. Sent with every request to the base URL origin; values may use %{} templates. Sensitive values are sealed at rest and masked in logs and API responses. |
| Server parameters | Values for bare %{name} references in action templates. Sensitive parameters are sent only to the base URL origin. |
| Verify the server certificate | On by default. |
| Enabled | On by default. |
| Test path | For types that support it: path or absolute URL probed by Test connection (default: the base URL). |
| Trusted CA certificate(s) | PEM. Leave empty to use the system trust store. |
Select a server to open its panel: connection details, Last test, MDM sync interval or User-ID settings, headers, parameters and config, its Context actions, and Used by HTTP enforcement profiles. MDM servers also have an MDM devices view listing synchronised devices (Device, MAC, Compliant, OS, Owner, Last seen); select a device to see every MDM attribute, First seen and Written to endpoint.
Context actions tab
Section titled “Context actions tab”Stat tiles: Context actions, Failing, Enabled, Disabled, Executions (24h), Failed (24h). Filters: search (Action, URL, server…), All servers, All server types, and All / Enabled / Disabled / Failing.
| Column | Meaning |
|---|---|
| Action | Name, optional action type badge and description. |
| Server | Context server and its type. |
| Request | HTTP method and URL. |
| Body | Content type: JSON, XML, Text or Form. |
| Refs | Number of HTTP enforcement profiles that reference the action. |
| Last test | Result of the last test. |
| Last run | Status and time of the last run by policy or an integration, or never. |
| Status | Enabled / Disabled and failing badge. |
Action form fields:
| Field | Meaning |
|---|---|
| Start from a preset | New actions only. Built-in templates for Slack, Teams, Palo Alto User-ID, Fortinet SSO, Check Point Identity Awareness, ServiceNow and Splunk HEC, or Blank action. |
| Context server | Required. The server the request goes to. |
| Name | Required, unique per server, up to 128 characters. HTTP enforcement profiles reference it. |
| Action type | Informational, for example Send_Login_Info, Create_Ticket, Notify. |
| Description | Free text. |
| Method | GET, POST, PUT, PATCH or DELETE. Default POST. |
| URL | Required. Absolute URL, path relative to the server base URL, or a leading %{param}. {key} inserts the server API key. A URL outside the server’s origin is sent without the server’s credentials and headers. |
| Content type | Default application/json. |
| Timeout per attempt (s) | 0 to 120; 0 uses the server timeout. |
| Retries | 0 to 5, default 2. Retried after network errors, 408, 429 and 5xx. |
| Body | Template, up to 1 MiB. %{Namespace:Attribute} and bare %{param} references are expanded per request and encoded for the content type; unresolved references become empty. Insert buttons add common references such as %{Authentication:Username} or %{Connection:Client-Mac-Address}. |
| Headers, Parameters | Override server values with the same name. Built-in parameters: ip, user, full-username, mac, machine, role, posture, category, nas-ip, ssid, domain, requestid. |
| Response attributes | JSON path to Endpoint attribute mappings. After a 2xx JSON answer, the values are written to the request’s endpoint (for example result.number → ServiceNow Incident). |
| Enabled | On by default. |
Execution log tab
Section titled “Execution log tab”Stat tiles: Executions (24h), Success rate, Failed (24h), Skipped (24h), Queue. Filters: search (Action, profile, MAC, user, error…), All / Success / Failed / Skipped, source (Policy (enforcement), Integration (User-ID), Test runs), server, action, and a From / to time range. Auto-refresh reloads every 15 seconds.
| Column | Meaning |
|---|---|
| Time | When the action ran. |
| Source | Policy, integration or test. |
| Action | Action, server and enforcement profile. |
| Subject | MAC address and user name. |
| HTTP | Method and HTTP status. |
| Status | Result, with the error if any. |
| Latency | Total time and number of attempts. |
Select a row to see the full execution: enforcement profile, a link to the access record in the sign-in log, request and response bodies, unresolved references and attributes written to the endpoint.
Webhooks tab
Section titled “Webhooks tab”Stat tiles: Webhooks, Delivered (24h), Failed (24h), Pending retries, Disabled. Filters: search (Name, URL, topic…) and All / Enabled / Disabled / Failing / Retrying.
| Column | Meaning |
|---|---|
| Webhook | Name and payload URL. |
| Topics | Subscribed topics or patterns. |
| Signed | HMAC when a signing secret is set, otherwise no. |
| Last delivery | Status and time of the last delivery, or never. |
| Last 24 h | Delivered and failed counts (event traffic only). |
| Pending | Deliveries waiting for a retry. |
| Last test | Result of the last test event. |
| Status | Enabled / Disabled and failing badge. |
Webhook form fields:
| Field | Meaning |
|---|---|
| Name | Required, up to 128 characters. |
| Description | Free text. |
| Payload URL | Required http(s):// URL. Events are POSTed as JSON; any 2xx answer is a success. |
| Events | All events (*), whole groups (auth.*), individual topics, or a custom pattern added with Pattern. policy.http_action is never delivered. |
| Signing secret | Optional. Generate creates a whsec_… secret; copy it to the receiver before saving, because it is masked afterwards. Empty means deliveries are not signed. |
| Extra headers | Name, value and Sensitive flag. |
| Timeout (s) | 1 to 60, default 10. |
| Max retries | 0 to 10, default 5. Backoff starts at 30 seconds and doubles up to 1 hour, with ±20 % jitter. |
| Verify the TLS certificate | On by default. |
| Enabled | On by default. |
| Trusted CA certificate(s) | PEM. Leave empty to use the system trust store. |
Event topics available in the picker:
| Topic | Event |
|---|---|
auth.accept, auth.reject |
RADIUS or web authentication accepted or rejected. |
tacacs.authen, tacacs.author, tacacs.acct |
TACACS+ authentication, authorization and accounting. |
session.start, session.update, session.stop |
Network session started, interim update, stopped. |
endpoint.created, endpoint.updated, endpoint.profile_changed, endpoint.deleted, endpoint.bulk |
Endpoint lifecycle and bulk actions. |
posture.changed |
Endpoint posture token changed. |
guest.created, guest.approved, guest.expired, guest.login |
Guest account events. |
cert.issued, cert.revoked |
Certificate issued or revoked. |
coa.sent |
CoA or 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. |
Each delivery carries the headers X-NAC-Event (topic), X-NAC-Delivery (delivery ID) and X-NAC-Timestamp. When a secret is set, X-NAC-Signature is sha256= followed by the hex HMAC-SHA256 of <timestamp>.<body>.
Select a webhook to open its panel with URL, topics, delivery settings, 24-hour counts and Deliveries. The deliveries list filters by status (Pending, Success, Failed), source (Event traffic, Tests / redeliveries) and topic prefix, and shows Created, Topic, Status, Attempts, HTTP and Retry / result. Select a delivery to see the request and response; the Event ID stays the same across retries so the receiver can de-duplicate.
Integrations tab
Section titled “Integrations tab”The header shows the node name, the age of this replica’s caches, and an Auto-refresh (30 s) toggle. Queue and syslog counters describe this replica only.
| Area | Shows |
|---|---|
| Stat tiles | Context actions (24h), Action queue, Webhook deliveries (24h), Webhook retries, Syslog targets (healthy / enabled). |
| Palo Alto Networks User-ID | Each firewall or Panorama: Firewall, Type, User-ID (Active / Off), Sent (24h), Failed (24h), Last success, Last error. Session start and stop send login and logout (and optional role tags) to every enabled firewall with User-ID. |
| MDM synchronisation (Intune, Jamf Pro) | Each MDM server: MDM server, Sync (interval), Last run, Last success, Next run, Devices, Updated / removed. Each device MAC becomes an endpoint with MDM attributes usable in role mapping and enforcement conditions. |
| Webhooks | Enabled count, deliveries and failures in 24 hours, pending retries, queue and dropped deliveries. |
| Syslog / SIEM targets | Each target: Target, Transport, Status, Sent, Dropped / errors, Last sent. Manage opens Log export. |
Actions
Section titled “Actions”| Action | Where | What it does |
|---|---|---|
| Add context server | Context servers | Pick a type, fill the form, then Create server. The new server’s panel opens. Change type goes back to the type picker. |
| Test connection | Context servers, Integrations | Calls the server (the test path or base URL) with its credentials and records the result and latency. |
| Sync now | Server panel, Integrations | Schedules an MDM sync; the poller starts it within 30 seconds. Needs the server and MDM sync to be on. |
| Edit | Servers, actions, webhooks | Opens the form. Save stores the change. |
| Delete | Context servers | Refused while the server still has actions or HTTP enforcement profiles reference it. Otherwise its stored credentials and cached tokens are discarded and, for MDM servers, the attributes it wrote are removed from endpoints in the background. |
| Add action | Context actions | Opens the action form (needs at least one context server). Create action saves it and opens its panel. |
| Duplicate | Context actions | Copies the action as <name> (copy). Sensitive header and parameter values are not copied. |
| Test | Context actions | Opens Test action with a synthetic request context (Client MAC, Username, Client IP, Do not load the endpoint, Extra attributes, Parameter overrides). Render only shows the expanded request and sends and logs nothing. Send request calls the server even if the action is disabled, writes the result to the execution log and, on a 2xx JSON answer, writes the response attributes to the endpoint. |
| Delete | Context actions | Blocked while HTTP enforcement profiles reference the action. Its execution log is kept. |
| Add webhook | Webhooks | Opens the form. Create webhook saves it and opens its panel. |
| Send test | Webhooks | Sends a webhook.test event and shows the delivery. Test deliveries are marked manual. |
| Redeliver | Webhook deliveries | Sends the delivery again as a new manual delivery, without automatic retries. |
| Delete | Webhooks | Deletes the webhook and its delivery history, and drops pending retries. |
| Add firewall, Intune, Jamf Pro | Integrations | Opens Add context server with that type preselected. |
| User-ID log, Synchronised devices | Integrations | Open the execution log filtered on that firewall, or the MDM devices list. |
| Bulk Test, Enable, Disable | Servers, actions, webhooks | Applies to the selected rows. Bulk tests are limited to 50 actions or webhooks. A bulk action test runs without a request context; select Render only (dry run) to send nothing. |
| Refresh | All tabs | Reloads the data. |
Permissions
Section titled “Permissions”- View: any role with
admin:read: Tenant Administrator, Network Administrator, Read-only Administrator and Platform Administrator. - Change:
admin:write: Tenant Administrator and Platform Administrator. Tests, syncs and redeliveries also needadmin:write.