Events & Webhooks

This page covers tools in the Events & Webhooks domain, powered by the Eventus API. Events represent activity across the Shipwell platform (e.g. shipment.created, shipment.carrier_assigned, order.updated). Webhooks subscribe to those events and deliver payloads to your endpoints.

Event Tools

Tool Description Use Case Access
list_events List platform events with filters "Show me all shipment events from the last 24 hours" Read
get_event Get a specific event by ID Retrieve the full payload of an event for debugging or audit Read
list_event_names List all valid event name strings by version Discover available event types before configuring webhook subscriptions Read
Note

Call list_event_names first to get the exact event name strings (e.g. shipment.carrier_assigned) required when setting enabled_events on a webhook.

Webhook Tools

Tool Description Use Case Access
list_webhooks List all webhook configurations View existing webhook subscriptions and their status Read
get_webhook Get a single webhook by ID Inspect which events a webhook is subscribed to and its endpoint URL Read
create_webhook Create a new webhook subscription Subscribe an endpoint to receive shipment.created or other platform events Write
update_webhook Update a webhook (full replacement) Replace all webhook settings including URL, enabled events, and status Write
patch_webhook Update a single webhook field Toggle a webhook ACTIVE/INACTIVE without touching other fields Write
delete_webhook Delete a webhook subscription Remove a webhook that is no longer needed Write
Note

Prefer patch_webhook over update_webhook when changing a single field — update_webhook is a full PUT replacement that will overwrite all fields.

Webhook Attempt Tools

Tool Description Use Case Access
list_webhook_attempts List delivery attempts across all webhooks "Show me all failed webhook deliveries in the last hour" Read
get_webhook_attempt Get a specific delivery attempt by ID Inspect the request and response for a failed webhook delivery Read
retry_webhook_attempt Retry a failed delivery attempt Re-send the original event payload after fixing a down endpoint or auth issue Write
Copyright © Shipwell 2025. All right reserved.