hb_describe_event
Describe a webhook event's summary, retry behavior, payload schema, and sample payload so you can understand and validate its data structure.
Instructions
Describe one webhook event: summary, delivery behaviour (retries), the data payload schema and a sample payload. Payloads hold ids, statuses, dates and a candidate_ref, never names, emails or health data. Knowledge only.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"event_type": "<event_type>"
},
"name": "hb_describe_event"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| event_type | Yes | e.g. occupational-health.request.submitted |