---
title: "List webhooks"
method: GET
path: "/api/v1/external/webhooks"
tags: ["Webhooks"]
---

# List webhooks

`GET /api/v1/external/webhooks`

## Request

- Base URL: `https://api.wove.com`
- URL: `https://api.wove.com/api/v1/external/webhooks`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/wove/apis/wove-external-api/docs/api/v1/external/webhooks/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all configured webhooks for your organization.

## Webhook Events

The following events can trigger webhooks:
- `extraction.completed` - Document extraction successful
- `extraction.failed` - Document extraction failed
- `validation.completed` - Cross-validation completed
- `validation.failed` - Cross-validation failed
- `merge.completed` - Document merge completed
- `merge.failed` - Document merge failed
- `document.uploaded` - New document uploaded
- `document.deleted` - Document deleted
- `shipment.created` - Shipment created
- `shipment.updated` - Shipment updated
- `source.processing.completed` - Rate sheet source processing completed
- `source.processing.failed` - Rate sheet source processing failed
- `tariff.changed` - The duty treatment followed by a tariff subscription changed. Delivered only
  to the webhook a subscription names; see Tariff Subscriptions.

## Payload Format

All webhook payloads follow this structure:
```json
{
  "event": "extraction.completed",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "data": { /* event-specific data */ }
}
```

See the schemas section for detailed payload structures for each event type.

## Response `200`

Webhooks retrieved successfully

- object
  - `success` boolean
  - `data` Webhook[]
    - `id` string
    - `url` string, uri
    - `events` string[]
    - `description` string
    - `isActive` boolean
    - `createdAt` string, date-time
    - `lastTriggeredAt` string, date-time

---

[API](https://skmtc.dev/wove/apis/wove-external-api.md) - [All operations](https://skmtc.dev/wove/apis/wove-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wove/apis/wove-external-api/revisions/37290e267e07?raw)