Skip to content
Home/
REST API Reference
/
/
HITL Event

HITL Event

A single event in a Fin human-in-the-loop consultation on a conversation.

hitl_cycle_idstring

Identifies the consultation this event belongs to. The same on every event of one consultation, so it is not unique per event.

Example:"3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80"
event_typestring

What happened.

Enum:"fin_consultation_started""fin_draft_proposed""fin_teammate_input_received""fin_draft_revised""fin_consultation_finished"
Example:"fin_consultation_started"
conversation_part_idstring or null

The conversation part this event relates to, where one exists.

Example:"4471002"
rule_idstring or null

The escalation rule that triggered the consultation, as recorded when it began. Null if no rule triggered it.

Example:"88"
rule_namestring or null

The rule's name as recorded when the consultation began, which may differ from its current name.

Example:"Refunds over $100"
created_atinteger

Unix timestamp for when the event occurred. Approximate on fin_draft_proposed.

Example:1767225600
dataobject

Fields specific to this event. Which are present depends on event_type — see the endpoint description for the full mapping.

{
  "hitl_cycle_id": "3f2a91c4-8e77-4d61-9a2b-0c5d7e1f4a80",
  "event_type": "fin_consultation_started",
  "conversation_part_id": "4471002",
  "rule_id": "88",
  "rule_name": "Refunds over $100",
  "created_at": 1767225600,
  "data": {
    "channel": "email",
    "rule_threshold_percent": 60,
    "confidence_percent": 42,
    "sharp_ask": "How long do refunds take?",
    "ask_rationale": "No article covers refund timelines.",
    "issue_summary": "Customer chasing a refund.",
    "customer_question": "Where is my refund?",
    "draft": "Refunds are processed within 30 days.",
    "round_index": 1,
    "teammate_input": "Tell them 5 business days.",
    "reviewer_admin_id": "4001",
    "regeneration_outcome": "answer",
    "revised_draft": "Refunds take 5 business days.",
    "outcome": "approved",
    "approved_draft_type": "revised",
    "final_draft": "Refunds take 5 business days.",
    "sent_text": "Refunds take 5 business days.",
    "duration_seconds": 180,
    "rounds_count": 1,
    "payload_truncated": false
  }
}