ECA custom event¶
Available since: 1.0.0
Provided tokens
| Token | Description |
|---|---|
[user] |
The current user. Alias: current_user |
[htmx] |
Information about the current HTMX request. |
[htmx:is_request] |
Whether the current request was sent by HTMX ("1" or "0"). |
[htmx:boosted] |
Whether the current request was boosted by HTMX ("1" or "0"). |
[htmx:history_restore] |
Whether the current request is for HTMX history restoration ("1" or "0"). |
[htmx:target] |
The value of the HX-Target request header. |
[htmx:trigger] |
The value of the HX-Trigger request header. |
[htmx:trigger_name] |
The value of the HX-Trigger-Name request header. |
[htmx:current_url] |
The value of the HX-Current-URL request header. |
[htmx:prompt] |
The value of the HX-Prompt request header. |
[event] |
The event. |
[event:machine_name] |
The machine name of the ECA event. |
[VARIOUS] |
All tokens forwarded by the dispatcher. |
[session_user] |
The user account that dispatched the event, regardless if ECA is processing models under a different account. This is only available if ECA is configured to always run under a specific account. |
Event listening to a custom event.
Note: If an entity is involved, you have to use Custom Event Entity Aware.
Fields¶
Event ID-
The custom event ID. Leave empty to trigger all custom events.
The custom event ID to listen for. Leave empty to trigger on all custom events.