Workflows Overview
Event-driven automation engine with trigger matching, scheduled triggers, and configurable actions.
The PlatformXe Workflow Engine automates actions in response to events. Define triggers that match specific event types, and PlatformXe executes the configured actions whenever a matching event fires.
How it works
- You create a workflow with a trigger configuration (event type or schedule).
- When an event fires in PlatformXe, the engine evaluates all active workflows.
- Workflows with matching triggers execute their configured actions.
- Action results are logged and optionally forwarded via webhooks.
Trigger types
| Type | Description |
|---|---|
| Event-based | Fires when a specific platform event occurs (e.g. email.failed, file.uploaded) |
| Scheduled | Fires on a cron schedule (e.g. daily at 9:00 AM UTC) |
Action types
| Action | Description |
|---|---|
| Send notification | Send an email or SMS via the PlatformXe messaging service |
| Create task | Create a task record in your connected task system |
| Fire webhook | Send a custom HTTP POST to any URL |
| Call API | Make an authenticated API call to a PlatformXe or external endpoint |
Key features
- Event matching -- subscribe to exact event types or use wildcard patterns
- Scheduled triggers -- cron-based execution for periodic automation
- Action chaining -- execute multiple actions in sequence per workflow
- Conditional logic -- filter events with conditions before executing actions
- Execution logging -- every workflow run is logged with input, output, and timing
Workflows execute asynchronously using durable functions. Actions are guaranteed to run at least once, even if the initial execution encounters a transient failure.
API scope
Workflow endpoints require the events:manage scope on your API key.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/workflows | List workflows |
| POST | /api/v1/workflows | Create a workflow |
| PATCH | /api/v1/workflows/:id | Update a workflow |
| DELETE | /api/v1/workflows/:id | Delete a workflow |
| POST | /api/v1/workflows/evaluate | Manually trigger evaluation |
Next steps
- Triggers & Creation -- create workflows and configure triggers
- Evaluate Workflows -- manually test workflow evaluation