HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2

BUILD · MODULE 20

Automations

Define, validate, operate, observe, and retire typed event, schedule, and manual automations with signed callback delivery while preserving the independent authority, policy, and evidence boundary of every underlying business action.

BUSINESS CASES

Where this module fits

  • scheduled operational checks
  • event-triggered evidence and notification workflows
  • manual validate-only or authorized runs
  • signed webhook delivery
  • callback secret rotation
  • failed-delivery reconciliation
  • automation lifecycle governance

PRIMARY CONSUMERS

Who integrates it

  • workflow and integration developers
  • operations and reliability teams
  • automation and orchestration agents
  • security and audit reviewers

PREREQUISITES

What must exist first

  • automations:read or automations:write in the bearer-derived workspace
  • a server-owned approved action profile and typed trigger schema
  • separate current authority from the owning domain for every consequential execution
  • an SSRF-safe active callback endpoint and receiver-side signature verification when callbacks are used
  • caller-owned policies for idempotency, concurrency, retry, deduplication, failure handling, evidence retention, and receiver processing

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    ingest live OpenAPI and discover server-owned action profiles, trigger schemas, and workspace policy

  2. 02

    register an SSRF-safe HTTPS callback endpoint when signed outcome delivery is required and secure its one-time secret

  3. 03

    create a DRAFT automation with one typed trigger, approved action profile, secret-free bindings, callback reference, and bounded execution policy

  4. 04

    validate configuration and bindings without invoking the domain action

  5. 05

    activate or resume only after current trigger, endpoint, workspace, action-profile, and domain-policy checks pass

  6. 06

    for manual EXECUTE, obtain a fresh purpose-bound authorization from the owning domain and bind the request to one exact automation version

  7. 07

    distinguish run admission, domain outcome, callback attempt, and receiver acknowledgement as separate states

  8. 08

    rotate endpoint signing epochs, retry only eligible failed deliveries without re-running the business action, and retire endpoints or automations with retained evidence

MODULE CONTRACTS

Every mapped endpoint

Each operation states whether its request shape is authoritative in OpenAPI, reviewed as a planning profile, or intentionally left as an outline pending an owner schema.

POSTRetry callback delivery/api/v2/automation-deliveries/{delivery_uuid}/retriesPlanned capability: request an idempotent retry of an eligible failed delivery.GETList callback endpoints/api/v2/automation-endpointsPlanned capability: list signed callback destinations, key fingerprints, and delivery posture.POSTCreate callback endpoint/api/v2/automation-endpointsPlanned capability: register an HTTPS callback destination and return its signing secret exactly once.DELETEDelete callback endpoint/api/v2/automation-endpoints/{endpoint_uuid}Planned capability: disable and remove a callback endpoint while retaining delivery evidence.POSTRotate callback secret/api/v2/automation-endpoints/{endpoint_uuid}/secret-rotationsPlanned capability: rotate an endpoint signing secret with an explicit overlap window.POSTTest callback endpoint/api/v2/automation-endpoints/{endpoint_uuid}/testsPlanned capability: send a signed non-production test event to an active callback endpoint.GETList automations/api/v2/automationsPlanned capability: list signed automation rules visible to the caller.POSTCreate automation/api/v2/automationsPlanned capability: create an automation with explicit trigger, action, callback, and policy boundaries.GETGet automation/api/v2/automations/{automation_uuid}Planned capability: return an automation and its retained configuration history.PATCHUpdate automation/api/v2/automations/{automation_uuid}Planned capability: update or change the lifecycle state of an automation.GETList callback deliveries/api/v2/automations/{automation_uuid}/deliveriesPlanned capability: list signed callback attempts and delivery outcomes.GETList runs/api/v2/automations/{automation_uuid}/runsPlanned capability: list automation run outcomes and signed callback receipts.POSTRun automation/api/v2/automations/{automation_uuid}/runsPlanned capability: request an idempotent manual automation run.