Triggers

Fire a trigger

Evaluate the trigger condition and run the simulation template if met (or forced).

post/v1/triggers/{trigger_id}/fire

Request

  • Base URL: https://api.algenta.ai
  • URL: https://api.algenta.ai/v1/triggers/{trigger_id}/fire
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

trigger_idstring required

Request body

forceboolean

Run simulation even if condition is not currently met.

Response

Successful Response

trigger_idstring required
condition_metboolean required
firedboolean required
simulation_run_idstring nullable required
recommended_actionstring nullable required
expected_valuenumber nullable required
confidencenumber nullable required
fired_atstring date-time nullable required
execution_statusstring nullable
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.