# Webhook Sample Alert Payloads

This page provides sample JSON webhook payloads for switch-related Event IDs. Each example shows the common webhook parameters and the alert-specific `alertData` object.

### Usage

Use the `alertId` field to identify the Event ID, and use the `alertData` object to read alert-specific information for each event.

### Switch Port Status Events

#### switch\_link\_status

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECW536S",
  "deviceType": "switch",
  "alertId": "switch_link_status",
  "alertType": "Switch Port Link Status Change",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "port": "3",
    "status": "up"
  }
}
```

#### switch\_stp\_port\_status

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_stp_port_status",
  "alertType": "Switch STP Port Status Change",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "port": "3",
    "status": "blocking"
  }
}
```

#### switch\_lbd\_port\_status

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_lbd_port_status",
  "alertType": "Switch LBD Port Status Change",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "port": "3",
    "status": "looped"
  }
}
```

### Switch Device Setting Events

#### switch\_vlan\_setting\_update

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_vlan_setting_update",
  "alertType": "Switch VLAN Settings Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### switch\_system\_setting\_update

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_system_setting_update",
  "alertType": "Switch System Settings Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### switch\_port\_setting\_update

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_port_setting_update",
  "alertType": "Switch Port Settings Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### general\_switch\_remote\_syslog\_change

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "general_switch_remote_syslog_change",
  "alertType": "Switch Remote Syslog Settings Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

### Switch Network Policy Events

#### switch\_policy\_vlan\_creation

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_policy_vlan_creation",
  "alertType": "VLAN Creation",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "vlan_id": "1",
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### switch\_policy\_vlan\_update

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_policy_vlan_update",
  "alertType": "VLAN Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "vlan_id": "1",
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### switch\_policy\_vlan\_removal

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_policy_vlan_removal",
  "alertType": "VLAN Removal",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "vlan_id": "1",
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```

#### switch\_policy\_system\_setting\_update

```json
{
  "sentAt": "2026-03-11T06:10:55.000Z",
  "organizationId": "6115e91491d5ef56745ab984",
  "organizationName": "Engenius Cloud",
  "hierarchyviewId": "6115e91491d5ef56745ab984",
  "hierarchyviewName": "Example Hierarchy View",
  "networkId": "9915e35691d5ef7f545ab794",
  "networkName": "Example Network",
  "deviceSerial": "21B0V2111JEL",
  "deviceMac": "88:dc:96:97:07:5c",
  "deviceName": "Example Device",
  "deviceModel": "ECS5512FP",
  "deviceType": "switch",
  "alertId": "switch_policy_system_setting_update",
  "alertType": "Network Switch System Settings Update",
  "alertLevel": "notice",
  "occurredAt": "2026-03-11T06:09:33.000Z",
  "alertData": {
    "operator": "testuser@example.com",
    "operator_name": "testuser"
  }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.engenius.ai/webhook/webhook-sample-alerts/switch/webhook-sample-alert-payloads.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.