Skip to main content
GET
/
api
/
v2
/
webhooks
/
events
List event types
curl --request GET \
  --url https://agp.eu.hcompany.ai/api/v2/webhooks/events \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "description": "<string>"
}
Lists every concrete event type that can appear in a webhook’s enabled_events, with a human-readable description. Use it to populate subscription UIs or to discover types added after you integrated. Returns an array of event type definitions.

​
The event type definition object

​
type
string
The event type identifier, e.g. session.completed.
​
description
string
When the event is sent.

​
Examples

curl https://agp.eu.hcompany.ai/api/v2/webhooks/events \
  -H "Authorization: Bearer $HAI_API_KEY"
Response
[
  {
    "type": "session.awaiting_tool_results",
    "description": "Sent when the agent is waiting for client-side tool results."
  },
  {
    "type": "session.completed",
    "description": "Sent when a session finishes successfully."
  },
  {
    "type": "session.failed",
    "description": "Sent when a session fails."
  },
  {
    "type": "session.idle",
    "description": "Sent when the agent finishes a run and waits for the next message."
  },
  {
    "type": "session.status_updated",
    "description": "Sent on every session status change, including running, completed, failed, timed out, interrupted, paused, idle, or awaiting tool results."
  },
  {
    "type": "session.timed_out",
    "description": "Sent when a session exceeds its time limit."
  }
]