# Improvado Webhooks API

**Canonical:** https://apis.io/apis/improvado/improvado-webhooks-api/  
**Provider:** Improvado — https://apis.io/providers/improvado/  
**Base URL:** https://embedded.improvado.io  
**Documentation:** https://developers.improvado.io/api

Improvado Webhooks API is one of 18 APIs that [Improvado](https://apis.io/providers/improvado/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

Manage webhook endpoints that receive event notifications from Improvado. Webhooks let your application react to platform events (extraction completion, load completion, etc.) in near real time, without polling. Each endpoint is workspace-scoped and subscribes to one or more event types. Lifecycle: 1. **Register** an endpoint with the URL of your receiver and the event types you care about. Improvado returns an `id` and a `secret`, and the endpoint is created in `unverified` status. 2. **Verify** ownership by calling the verify action. Improvado sends a GET request to your URL with `X-Improvado-Verify-Token` and `X-Improvado-Challenge` headers. Your receiver must respond with HTTP 200 and the challenge value as the response body. After successful verification the endpoint moves to `active`. 3. **Receive events.** Improvado POSTs JSON payloads `{id, type, timestamp, data}` to your URL. Each request is signed with HMAC-SHA256 in the `X-Improvado-Signature` header (using the endpoint's secret) and includes `X-Improvado-Idempotency-Key` for safe retry handling. 4. **Rotate the secret** at any time. Rotation invalidates the previous secret immediately and resets the endpoint to `unverified` until you re-verify. Failed deliveries are retried up to four times with backoff `[0s, 2s, 5s, 10s]`. Receivers should aim to respond within a few seconds and return 2xx for successful processing.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v3/webhook_endpoints/` | List webhook endpoints |
| POST | `/api/v3/webhook_endpoints/` | Create a webhook endpoint |
| GET | `/api/v3/webhook_endpoints/{id}/` | Get a webhook endpoint |
| PATCH | `/api/v3/webhook_endpoints/{id}/` | Update a webhook endpoint |
| DELETE | `/api/v3/webhook_endpoints/{id}/` | Delete a webhook endpoint |
| POST | `/api/v3/webhook_endpoints/{id}/verify/` | Verify a webhook endpoint |
| POST | `/api/v3/webhook_endpoints/{id}/regenerate_secret/` | Rotate the signing secret |
| GET | `/api/v3/webhook_event_types/` | List available webhook event types |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/improvado/refs/heads/main/openapi/improvado-webhooks-api-openapi.yml
- **Documentation** — https://improvado.io/llms.txt
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/improvado/refs/heads/main/llms/improvado-site-llms.txt
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/improvado/refs/heads/main/authentication/improvado-authentication.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/improvado/refs/heads/main/rate-limits/improvado-rate-limits.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/improvado/refs/heads/main/errors/improvado-error-codes.yml

## Other Improvado APIs (12)

- [Improvado Embedded API v3](https://apis.io/apis/improvado/improvado-embedded-api-v3/)
- [Improvado Customer MCP](https://apis.io/apis/improvado/improvado-customer-mcp/)
- [Improvado Accounts API](https://apis.io/apis/improvado/improvado-accounts-api/)
- [Improvado Authentication API](https://apis.io/apis/improvado/improvado-authentication-api/)
- [Improvado Automated Recipes API](https://apis.io/apis/improvado/improvado-automated-recipes-api/)
- [Improvado Data source connections API](https://apis.io/apis/improvado/improvado-data-source-connections-api/)
- [Improvado Data sources API](https://apis.io/apis/improvado/improvado-data-sources-api/)
- [Improvado Data tables API](https://apis.io/apis/improvado/improvado-data-tables-api/)
- [Improvado Destination connections API](https://apis.io/apis/improvado/improvado-destination-connections-api/)
- [Improvado Destinations API](https://apis.io/apis/improvado/improvado-destinations-api/)
- [Improvado Extraction templates API](https://apis.io/apis/improvado/improvado-extraction-templates-api/)
- [Improvado Extracts API](https://apis.io/apis/improvado/improvado-extracts-api/)

## Tags

Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/improvado/improvado-webhooks-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/improvado/.