BrainGrid Controller
Process Orchestrator
Trigger Types
API Trigger

API Trigger

The API Trigger fires when a specific API endpoint is called and the response matches the configured method and status code. Use it to start a process in response to internal or external API activity.

Create API Trigger Configuration dialog

Configuration

FieldDescription
TitleA name for this trigger
DescriptionOptional notes about when this trigger fires
ModeStatus Code to match on HTTP response codes, or Timed Out to fire when the request exceeds a time limit
MethodThe HTTP method to watch: GET, POST, PUT, or DELETE
StatusOne or more HTTP status codes that activate the trigger (e.g. 201, 400). Multiple codes can be selected
Api UrlThe endpoint or window event to monitor