HITL

Create HITL config

Create a new HITL configuration with messaging channels and timeout settings.

post/api/v1/hitl

Request

Base URL: https://api.proof.holdings
URL: https://api.proof.holdings/api/v1/hitl
Auth: HTTP bearer

Request body

namestring required

Name for this HITL configuration

circle_idstring

Optional Circle to route this Approval through (h-approvals-circle-reshape). When set, recipients come from the circle's members; the caller must own the circle (403 otherwise). Either channels or circle_id is required.

timeout_secondsnumber

Default timeout in seconds for confirmations (60–86400)

profile_idstring

Optional public profile to associate with this HITL config for branded messages. When omitted, the user's primary profile is used. The caller must own the profile (403 otherwise).

Example request

{
  "name": "Production Approvals",
  "channels": [
    {
      "config": {
        "chat_id": "123456789"
      }
    }
  ],
  "circle_id": "507f1f77bcf86cd799439011",
  "timeout_seconds": 3600,
  "profile_id": "507f1f77bcf86cd799439011"
}

Response

HITL config created

idstring required

MongoDB ObjectId

user_idstring required

MongoDB ObjectId

namestring nullable

profile_idstring

MongoDB ObjectId

circle_idstring

MongoDB ObjectId

timeout_secondsinteger required

status'pending' | 'active' | 'archived' required

Status of a HITL configuration

environment'production' | 'test' required

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "user_id": "507f1f77bcf86cd799439011",
  "name": "Production Approvals",
  "profile_id": "507f1f77bcf86cd799439011",
  "circle_id": "507f1f77bcf86cd799439011",
  "channels": [
    {
      "config": {
        "chat_id": "123456789"
      }
    }
  ],
  "timeout_seconds": 3600,
  "status": "active",
  "environment": "production"
}

Changes

No recorded changes to this operation across all 1 revision of this API.