Skip to main content

Check hook variables

POST 

/api/2/hooks/:hook_key_str/check

Preview the variables a hook extracts from a payload.

Applies the hook's stored jmespath variables to the request body (JSON, YAML or form-encoded) and returns {var_name: match} for each one that matches, without running the hook's workflow. Accepts GET, PUT and DELETE too, as the legacy route did; a form body is read only for POST and PUT.

Request​

Responses​

Successful Response