> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks

> Create, inspect, test, rotate, and remove webhooks and view delivery attempts.

| Tool | Description |
| - | - |
| `create_webhook` | Register an account or study-scoped webhook with event subscriptions |
| `list_webhooks` | List webhook registrations without signing secrets |
| `get_webhook` | Inspect one registration without its signing secret |
| `rotate_webhook_secret` | Replace its signing secret; the new value is shown once |
| `test_webhook` | Send a signed, data-free test event to the registered URL |
| `list_webhook_deliveries` | Page through delivery attempts and coarse failure reasons |
| `delete_webhook_by_id` | Remove one registration by ID |
| `delete_webhook` | Deprecated URL form; use `delete_webhook_by_id` |

Webhooks can cover an account or one study. Subscribe to `interview.completed`, `study.completed`, `report.ready`, `study.paused`, `study.resumed`, or `study.stopped`. The three lifecycle events currently cover public API pause, resume, and stop calls. `create_webhook` returns an HMAC signing secret once; `rotate_webhook_secret` returns the replacement once. Store it securely and never repeat it in logs or ordinary chat output. List and get responses never include a secret.

Use `test_webhook` to verify the destination and `list_webhook_deliveries` to inspect recent attempts. The test event contains no participant or study data. Delivery history contains status and coarse errors, not request bodies.

Creating a webhook changes an external integration and should require user confirmation. If a temporary webhook is created for testing, delete it before finishing.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.