WOwove
Webhooks

Create webhook

Create a new webhook endpoint for receiving notifications.

Example Payloads

extraction.completed

{
  "event": "extraction.completed",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "data": {
    "document": { /* WebhookDocument object */ },
    "entityType": "shipments",
    "entityId": "1014560123456789012"
  }
}

validation.completed

{
  "event": "validation.completed",
  "timestamp": "2024-01-15T10:30:00.000Z",
  "data": {
    "jobId": "1014560123456789012",
    "entityId": "1014560123456789012",
    "entityType": "shipments",
    "documents": [ /* array of WebhookDocument objects */ ],
    "validationResult": { /* validation results */ },
    "itemsValidated": 15,
    "issuesFound": 2,
    "completedAt": "2024-01-15T10:30:00.000Z",
    "type": "cross-validation"
  }
}
post/api/v1/external/webhooks

Request

Request body

urlstring uri required

HTTPS URL to receive webhook notifications

eventsstring[] required
descriptionstring

Response

Webhook created successfully

successboolean

Example response

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

Changes

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