DOCUMENTATIONv2

POST

Automations

Create callback endpoint

/api/v2/automation-endpoints

AUTHENTICATIONBearer token · automations:writeAUTHORITATIVE OWNERautomation-serviceCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: register an HTTPS callback destination and return its signing secret exactly once.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future callback endpoint workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Create or advance

What changes

None today: this route is not executable. Its intended behavior is: when promoted, returns one signing secret exactly once and stores only its protected verifier or encrypted form; endpoint creation does not create an automation or send a production event.

WHY IT MATTERS

Lets people and agents prepare for callback endpoint without falsely presenting roadmap scope as a live capability.
Gives people and agents a contract-backed way to advance callback endpoint.
Makes triggers, execution attempts, callback destinations, delivery evidence, and retry behavior explicit without granting the automation ambient access to another domain.

ISOLATION + AUTHORITY

Tenant, workspace, automation definition, trigger, run, callback endpoint, secret version, delivery attempt, receipt, retry policy, and target-domain authority remain distinct. Creating or running an automation does not bypass the authorization, idempotency, policy, or lifecycle gates of any action it requests. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Authenticate at the documented boundary: bearer+scope.
Treat the proposed name (body), url (body), event_types (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.

WHAT TO DO NEXT

Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
Use the stated owner, lifecycle, authority boundary, and provisional callback endpoint profile to prepare requirements and conformance tests without sending a request.
Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
Its capability-registry profile is provisional integration guidance, not an executable request schema.
Use callback endpoint only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Treat the proposed name (body), url (body), event_types (body) as planning input only; re-generate the request from deployed OpenAPI before making a call.
Distinguish definition state, enablement, trigger admission, run creation, execution outcome, callback delivery, receipt, retry, and the authoritative state of any referenced business resource.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.
When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing automations:write authority.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated stable key reused for retries of the same logical mutation.EXAMPLEpost-api-v2-automation-endpoints-request-001

namebodyRequired

stringEndpoint label.EXAMPLEname-01

urlbodyRequired

HTTPS URLCallback destination.EXAMPLEurl-01

event_typesbodyRequired

identifier[]Subscribed event types.

timeout_msbodyOptional

integerDelivery timeout.EXAMPLE1

REQUEST

JSON body example

{
  "name": "name-01",
  "url": "url-01",
  "event_types": [],
  "timeout_ms": 1
}

RESPONSES

Status and payload examples

201Mutation accepted and canonical state returned.Not executable · JSON RESPONSE+

{
  "result": "See the operation's authoritative OpenAPI response schema."
}

INTEGRATION DECISION

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from the future automation definition, trigger, schedule, run, action, and retained receipt lifecycle through an implemented operation.
ESCALATE WHEN: Escalate readiness questions rather than approximating a planned automation with ungoverned repeated calls.

401Bearer credential is missing, expired, or invalid.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from the future automation definition, trigger, schedule, run, action, and retained receipt lifecycle through an implemented operation.
ESCALATE WHEN: Escalate readiness questions rather than approximating a planned automation with ungoverned repeated calls.

403The principal lacks the required scope, role, tenant, or step-up authority.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The principal lacks the required scope, role, tenant, or step-up authority."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from the future automation definition, trigger, schedule, run, action, and retained receipt lifecycle through an implemented operation.
ESCALATE WHEN: Escalate readiness questions rather than approximating a planned automation with ungoverned repeated calls.

422Path, query, or body validation failed.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from the future automation definition, trigger, schedule, run, action, and retained receipt lifecycle through an implemented operation.
ESCALATE WHEN: Escalate readiness questions rather than approximating a planned automation with ungoverned repeated calls.

503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from the future automation definition, trigger, schedule, run, action, and retained receipt lifecycle through an implemented operation.
ESCALATE WHEN: Escalate readiness questions rather than approximating a planned automation with ungoverned repeated calls.

OPERATIONAL NOTES

Security and lifecycle guarantees

The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
Mutations are retry-safe only when the same Idempotency-Key and canonical request body are reused.

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗