Veho Tech Webhooks

generated: '2026-07-21'
method: searched
source: openapi/veho-tech-api-openapi-original.yml (webhooks tag + EventType/WebhookEvent schemas)
type: Webhooks
spec_type: null
note: >-
  Veho publishes no AsyncAPI document; this captures the documented webhook
  surface. Webhook configurations bind one event type + service type to an
  HTTPS endpoint (with optional custom headers, e.g. an API key header Veho
  should send). Delivered events are queryable and replayable via the API.
management:
  configure:
  - {operation: getWebhookConfigurations, method: GET, path: /webhooks/webhookConfigurations}
  - {operation: addWebhookConfiguration, method: POST, path: /webhooks/webhookConfigurations}
  - {operation: findWebhookConfigurationById, method: GET, path: '/webhooks/webhookConfigurations/{id}'}
  - {operation: updateWebhookConfigurationById, method: PATCH, path: '/webhooks/webhookConfigurations/{id}'}
  - {operation: deleteWebhookConfigurationById, method: DELETE, path: '/webhooks/webhookConfigurations/{id}'}
  observe:
  - {operation: getWebhookEvents, method: GET, path: /webhooks/webhookEvents, notes: 'filters: occurredAtMin/Max, orderId, packageId, endpoint, trackingId, barcode, status'}
  - {operation: getWebhookEventsById, method: GET, path: '/webhooks/webhookEvents/{id}'}
  replay:
  - {operation: replayWebhookEvents, method: POST, path: /webhooks/replay}
configuration_fields:
  endpoint: HTTPS URL events are POSTed to (required)
  eventType: one of the package.* event types below (required)
  serviceType: delivery | pickup (required)
  customHeaders: 'map of headers Veho sends when calling the endpoint (e.g. {"KEY-1": "..."})'
event_types:
- package.created
- package.pickedUpFromClient
- package.droppedOffAtVeho
- package.pickedUpFromVeho
- package.delivered
- package.cancelled
- package.misdelivered
- package.discarded
- package.notReceivedFromClient
- package.pendingReturnToClient
- package.returnedToClient
- package.rescheduled
- package.delayed
- package.arrivedAtFacility
- package.departedFromFacility
- package.hadDeliveryIssue
- package.outForPickup
- package.pickedUpFromConsumer
- package.pickupSkipped
- package.pickupDroppedOffAtVeho
- package.pickupFailed
- package.pickupTransferredToExternalCarrier
event_payload:
  schema: WebhookEvent (openapi/veho-tech-api-openapi-original.yml#/components/schemas/WebhookEvent)
  fields: [id, createdAt, updatedAt, webhookConfigurationId, packageId, orderId, serviceType, eventType, endpoint, occurredAt, payload, trackingId, barcode, result]
security:
  signing: none documented — authentication of deliveries is via configurable customHeaders (e.g. a shared API key header)