Skip to content

Procedures

Submit human-collected input to Fin Procedures via the HITL (Human in the Loop) API.

 

When a Fin Procedure reaches a HITL step with the API channel enabled, Intercom sends a procedure.hitl_notification.created webhook to your system. Your system collects the required input and responds via the callback endpoint documented here.

 

This API requires the Procedures HITL API feature to be enabled for your workspace and an OAuth token with the write_conversations scope.

Collect Agent Input Request

Request body for submitting human-collected input to a HITL procedure step.

step_idstringrequired

The step_id from the webhook payload, identifying which HITL step this response is for.

Example:"d5b81f72-adb9-4317-b973-75b3c3624c09"
attribute_valuesArray of objectsrequired

Array of attribute values matching the attributes_to_collect from the webhook payload. Must include a value for every attribute listed.

{ "step_id": "d5b81f72-adb9-4317-b973-75b3c3624c09", "attribute_values": [ { … } ] }