Webhooks

List webhooks

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.

All webhook payloads follow this structure:

{
  "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.

get/api/v1/external/webhooks

Base URL
https://api.wove.com
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.

Webhooks retrieved successfully

successboolean

{
  "data": [
    {
      "id": "1014560123456789012",
      "url": "https://your-app.com/webhook"
    }
  ]
}

No recorded changes to this operation across all 1 revision of this API.