Webhook and Automation
Webhook and Automation

Automate validation and downstream actions around IOModel changes.

Automation keeps architecture honest without manual effort. IOModel gives you two automation surfaces: CI pipelines and repository events for Git-projects, and outbound platform webhooks for cloud projects.

Automate with CI

The most reliable automation runs the IOModel CLI in your pipeline:

TriggerAction
Pull/merge requestValidate model and specs
Push to defaultRe-validate and publish a report
Pre-commitValidate changed files locally
# in any CI job
npx @iomodel/cli validate --json > validation.json

See CI Validation for full pre-commit and pipeline setup.

Repository events

Because Git-projects live in a repository, you can use your provider’s native events:

Trigger on events

Use repository webhooks/CI triggers (PR opened, push, tag).

Run validation

Invoke iomodel validate and gate on its exit code.

Act on results

Post the report as a PR comment, fail the check, or notify a channel.

Platform webhooks

For cloud projects, IOModel Studio emits outbound webhooks so you can drive downstream automation without polling. Subscribe an endpoint and receive an event when something meaningful happens:

EventFires when
branch.committedA new commit lands on a branch
branch.mergedA branch is merged into its target
validation.failedA model or spec validation fails
drift.detectedThe Collector reports drift from the model

Each delivery is a signed JSON payload your service can verify, then act on — kick off a pipeline, notify a channel, or open a ticket.

Pick the right surface

Use CI events for Git-projects (the repo is the trigger) and platform webhooks for cloud projects (Studio is the trigger). Both can call the same downstream automation — and the most valuable rule is the simplest: never let an invalid model merge.

Last updated on