> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/wifi-pineapple-pager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/wifi-pineapple-pager/payloads-1/alert-payloads.md).

# Alert Payloads

Pineapple Alert payloads are launched in response to events detected by the [Pineapple Recon](/wifi-pineapple-pager/recon.md) service.

Alert payloads are small, responsive payloads launched when events occur. An alert payload may generate a full screen alert, but can not otherwise interact with the user

### Keep it small!  <a href="#keep-it-small" id="keep-it-small"></a>

Remember - alerts can happen at any time. Generally, it’s important to keep an alert payload small, and perform simple actions.

Alert payloads can be launched when the user is on any screen; because they interrupt the user, they do not have a normal payload interface and can not launch dialogs or input pickers, but can use the [ALERT](/wifi-pineapple-pager/alert.md) DuckyScript comamnd to show information.

When designing an Alert payload, keep in mind that all the alert payloads for an event run whenever the event occurs. Playing a sound or setting a LED status may make sense, but if every payloads attempts to do so at the same time, it doesn’t help the user.

### Alert environment  <a href="#alert-environment" id="alert-environment"></a>

When an Alert payload is launched, it is given all the information about the event in the form of [environment variables](/wifi-pineapple-pager/payloads-1/speedrunning-payload-dev.md#variables). Environment variables are accessible in a payload by name, such as `${_RECON_SELECTED_AP_CHANNEL}`

**deauth\_flood\_detected**&#x20;

| Variable                                   | Payload                 | Description                              |
| ------------------------------------------ | ----------------------- | ---------------------------------------- |
| PAYLOAD\_HOME                              | All                     | Directory where the payload is installed |
| \_ALERT                                    | deauth\_flood\_detected | Alert name (`deauth_flood_detected`)     |
| \_ALERT\_DENIAL\_MESSAGE                   | deauth\_flood\_detected | Human-readable description of the event  |
| \_ALERT\_DENIAL\_SOURCE\_MAC\_ADDRESS      | deauth\_flood\_detected | Source of the denial flood               |
| \_ALERT\_DENIAL\_DESTINATION\_MAC\_ADDRESS | deauth\_flood\_detected | Destination of the denial flood          |
| \_ALERT\_DENIAL\_AP\_MAC\_ADDRESS          | deauth\_flood\_detected | Access point targetted denial flood      |
| \_ALERT\_DENIAL\_CLIENT\_MAC\_ADDRESS      | deauth\_flood\_detected | Client targetted by denial flood         |

<br>

**handshake\_captured**&#x20;

| Variable                                 | Payload             | Description                                                                                               |
| ---------------------------------------- | ------------------- | --------------------------------------------------------------------------------------------------------- |
| PAYLOAD\_HOME                            | All                 | Directory where the payload is installed                                                                  |
| \_ALERT                                  | handshake\_captured | Alert name (`handshake_captured`)                                                                         |
| \_ALERT\_HANDSHAKE\_SUMMARY              | handshake\_captured | Human-readable description of handshake                                                                   |
| \_ALERT\_HANDSHAKE\_AP\_MAC\_ADDRESS     | handshake\_captured | MAC address of the access point                                                                           |
| \_ALERT\_HANDSHAKE\_CLIENT\_MAC\_ADDRESS | handshake\_captured | MAC address of the client                                                                                 |
| \_ALERT\_HANDSHAKE\_TYPE                 | handshake\_captured | Type of handshake (`EAPOL`, `PMKID`)                                                                      |
| \_ALERT\_HANDSHAKE\_COMPLETE             | handshake\_captured | Is the handshake a complete 4-way + beacon handshake? (only `EAPOL`)                                      |
| \_ALERT\_HANDSHAKE\_CRACKABLE            | handshake\_captured | Does the handshake contain the proper packets to be considered attackable by normal tools? (only `EAPOL`) |
| \_ALERT\_HANDSHAKE\_PCAP\_PATH           | handshake\_captured | Path to the handshake pcap logfile                                                                        |
| \_ALERT\_HANDSHAKE\_HASHCAT\_PATH        | handshake\_captured | Path to the handshake hashcap 22000-format logfile                                                        |

<br>

**client\_connected**&#x20;

| Variable                                         | Payload           | Description                                 |
| ------------------------------------------------ | ----------------- | ------------------------------------------- |
| PAYLOAD\_HOME                                    | All               | Directory where the payload is installed    |
| \_ALERT                                          | client\_connected | Alert name (`client_connected`)             |
| \_ALERT\_CLIENT\_CONNECTED\_SUMMARY              | client\_connected | Human-readable summary of client connection |
| \_ALERT\_CLIENT\_CONNECTED\_CLIENT\_MAC\_ADDRESS | client\_connected | Client MAC address                          |
| \_ALERT\_CLIENT\_CONNECTED\_SSID                 | client\_connected | SSID client connected to                    |
| \_ALERT\_CLIENT\_CONNECTED\_SSID\_LENGTH         | client\_connected | Length of SSID client connected to          |

<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://documentation.hak5.org/wifi-pineapple-pager/payloads-1/alert-payloads.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
