ECA Endpoint response

Plugin ID: eca_endpoint:response

Available since: 1.1.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 identifier of the element the response is targeted at.
[htmx:trigger]	The identifier of the element that triggered the request. On Drupal 11 this is the element id, on Drupal 12 and later it is the CSS selector that htmx 4 sends. Prefer "trigger_name", which means the same thing on both.
[htmx:trigger_name]	The name attribute of the element that triggered the request, or empty if it has none. This has the same meaning on all supported Drupal versions.
[htmx:source]	The CSS selector of the element that triggered the request, for example button[name="first_item"]. Empty on Drupal 11, which does not send this information.
[htmx:request_type]	Whether the request targets a full page or a fragment: "full" or "partial". Empty on Drupal 11, which does not send this information.
[htmx:current_url]	The URL of the page the request was sent from.
[event]	The event.
[event:path_arguments]	The arguments of the request path.
[event:request]	The request.
[event:request:method]	The request method, e.g. "GET" or "POST".
[event:request:path]	The requested path.
[event:request:query]	The query arguments of the request.
[event:request:headers]	The request headers.
[event:request:content_type]	The content type of the request.
[event:request:content]	The content of the POST request.
[event:request:ip]	The client IP.
[event:uid]	The ID of the user account of the request.
[event]	The event.
[event:machine_name]	The machine name of the ECA event.
[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.

Attention

Don't forget to also add an ECA Endpoint access to your model, so that you can allow this endpoint to be requested, unless you determine that by some other means.

It's likely that you will need the Set access result for this, which is available from the ECA Access sub-module, that needs to be enabled separately.

Fields

First path argument — config key: first_path_argument

The first path argument to match up. This argument will be resolved from the URL path /eca/{first}/{second}.

Type: textfield · Required: yes · Default: empty string

The first path argument in the endpoint URL (/eca/{first}/{second}). This is the primary discriminator for routing to the correct ECA model.

Second path argument — config key: second_path_argument

Optionally specify a second path argument to match up. This argument will be resolved from the URL path /eca/{first}/{second}.

Type: textfield · Required: no · Default: empty string

The optional second path argument in the endpoint URL (/eca/{first}/{second}). Leave empty to match any second argument.