{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"org_id": "<string>",
"data": {
"task": {
"object": "task",
"task_id": "<string>",
"session_id": "<string>",
"agent_id": "<string>",
"done": true,
"prompt": "<string>",
"result": "<string>",
"error": "<string>",
"pending": {
"type": "question",
"question_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"customer_can_answer": true
},
"cursor": 123,
"metadata": {
"customer_id": "cus_42"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"active_seconds": 123,
"billed_minutes": 123,
"replay_url": "<string>",
"recording": {
"frames": 123
},
"events": [
{
"cursor": 123,
"message": "<string>",
"ts": "2023-11-07T05:31:56Z",
"data": {}
}
]
},
"session": {
"object": "session",
"session_id": "K7QM-24XP",
"code": "K7QM-24XP",
"agent_id": "<string>",
"invite_url": "https://guidinghand.ai/acme/billing/K7QM-24XP",
"device": {
"name": "<string>",
"width": 123,
"height": 123,
"app_version": "<string>"
},
"metadata": {
"customer_id": "cus_42"
},
"created_at": "2023-11-07T05:31:56Z",
"paired_at": "2023-11-07T05:31:56Z",
"last_active_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"task_count": 123,
"latest_task_id": "<string>"
},
"answer": {
"question_id": "<string>",
"answer": "<string>"
},
"decision": {
"approval_id": "<string>",
"note": "<string>"
}
}
}API Reference
Webhook event
Sent to your endpoint with a GuidingHand-Signature: t=<unix>,v1=<hex> header: the HMAC-SHA256 of <t>.<raw body> with your secret. Retried up to 4 times over about 3 minutes until you answer 2xx.
WEBHOOK
event
{
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"org_id": "<string>",
"data": {
"task": {
"object": "task",
"task_id": "<string>",
"session_id": "<string>",
"agent_id": "<string>",
"done": true,
"prompt": "<string>",
"result": "<string>",
"error": "<string>",
"pending": {
"type": "question",
"question_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"customer_can_answer": true
},
"cursor": 123,
"metadata": {
"customer_id": "cus_42"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"active_seconds": 123,
"billed_minutes": 123,
"replay_url": "<string>",
"recording": {
"frames": 123
},
"events": [
{
"cursor": 123,
"message": "<string>",
"ts": "2023-11-07T05:31:56Z",
"data": {}
}
]
},
"session": {
"object": "session",
"session_id": "K7QM-24XP",
"code": "K7QM-24XP",
"agent_id": "<string>",
"invite_url": "https://guidinghand.ai/acme/billing/K7QM-24XP",
"device": {
"name": "<string>",
"width": 123,
"height": 123,
"app_version": "<string>"
},
"metadata": {
"customer_id": "cus_42"
},
"created_at": "2023-11-07T05:31:56Z",
"paired_at": "2023-11-07T05:31:56Z",
"last_active_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"task_count": 123,
"latest_task_id": "<string>"
},
"answer": {
"question_id": "<string>",
"answer": "<string>"
},
"decision": {
"approval_id": "<string>",
"note": "<string>"
}
}
}Authorizations
An org API key (gh_live_…) from Settings → API keys in the console.
Body
application/json
Available options:
session.connected, session.disconnected, task.started, task.waiting_for_user, task.question_answered, task.waiting_for_approval, task.approval_decided, task.completed, task.failed, task.stopped Show child attributes
Show child attributes
Response
200
Received.