{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/mcp/tools/events-webhooks/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#events--webhooks\" aria-label=\"events  webhooks permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"events--webhooks\"></div>Events &#x26; Webhooks</h1>\n<p>This page covers tools in the Events &#x26; Webhooks domain, powered by the Eventus API. Events represent activity across the Shipwell platform (e.g. <code class=\"language-text\">shipment.created</code>, <code class=\"language-text\">shipment.carrier_assigned</code>, <code class=\"language-text\">order.updated</code>). Webhooks subscribe to those events and deliver payloads to your endpoints.</p>\n<h2 style=\"position:relative;\"><a href=\"#event-tools\" aria-label=\"event tools permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"event-tools\"></div>Event Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">list_events</code></td>\n<td>List platform events with filters</td>\n<td>\"Show me all shipment events from the last 24 hours\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_event</code></td>\n<td>Get a specific event by ID</td>\n<td>Retrieve the full payload of an event for debugging or audit</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">list_event_names</code></td>\n<td>List all valid event name strings by version</td>\n<td>Discover available event types before configuring webhook subscriptions</td>\n<td>Read</td>\n</tr>\n</tbody>\n</table>\n<div class=\"admonition admonition-info\"><div class=\"admonition-heading\"><h5><span class=\"admonition-icon\"><i></i></span>Note</h5></div><div class=\"admonition-content\"><p>Call <code class=\"language-text\">list_event_names</code> first to get the exact event name strings (e.g. <code class=\"language-text\">shipment.carrier_assigned</code>) required when setting <code class=\"language-text\">enabled_events</code> on a webhook.</p></div></div>\n<h2 style=\"position:relative;\"><a href=\"#webhook-tools\" aria-label=\"webhook tools permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"webhook-tools\"></div>Webhook Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">list_webhooks</code></td>\n<td>List all webhook configurations</td>\n<td>View existing webhook subscriptions and their status</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_webhook</code></td>\n<td>Get a single webhook by ID</td>\n<td>Inspect which events a webhook is subscribed to and its endpoint URL</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">create_webhook</code></td>\n<td>Create a new webhook subscription</td>\n<td>Subscribe an endpoint to receive <code class=\"language-text\">shipment.created</code> or other platform events</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">update_webhook</code></td>\n<td>Update a webhook (full replacement)</td>\n<td>Replace all webhook settings including URL, enabled events, and status</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">patch_webhook</code></td>\n<td>Update a single webhook field</td>\n<td>Toggle a webhook ACTIVE/INACTIVE without touching other fields</td>\n<td>Write</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">delete_webhook</code></td>\n<td>Delete a webhook subscription</td>\n<td>Remove a webhook that is no longer needed</td>\n<td>Write</td>\n</tr>\n</tbody>\n</table>\n<div class=\"admonition admonition-info\"><div class=\"admonition-heading\"><h5><span class=\"admonition-icon\"><i></i></span>Note</h5></div><div class=\"admonition-content\"><p>Prefer <code class=\"language-text\">patch_webhook</code> over <code class=\"language-text\">update_webhook</code> when changing a single field — <code class=\"language-text\">update_webhook</code> is a full PUT replacement that will overwrite all fields.</p></div></div>\n<h2 style=\"position:relative;\"><a href=\"#webhook-attempt-tools\" aria-label=\"webhook attempt tools permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"webhook-attempt-tools\"></div>Webhook Attempt Tools</h2>\n<table>\n<thead>\n<tr>\n<th>Tool</th>\n<th>Description</th>\n<th>Use Case</th>\n<th>Access</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code class=\"language-text\">list_webhook_attempts</code></td>\n<td>List delivery attempts across all webhooks</td>\n<td>\"Show me all failed webhook deliveries in the last hour\"</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">get_webhook_attempt</code></td>\n<td>Get a specific delivery attempt by ID</td>\n<td>Inspect the request and response for a failed webhook delivery</td>\n<td>Read</td>\n</tr>\n<tr>\n<td><code class=\"language-text\">retry_webhook_attempt</code></td>\n<td>Retry a failed delivery attempt</td>\n<td>Re-send the original event payload after fixing a down endpoint or auth issue</td>\n<td>Write</td>\n</tr>\n</tbody>\n</table>","headings":[{"value":"Events & Webhooks","depth":1},{"value":"Event Tools","depth":2},{"value":"Webhook Tools","depth":2},{"value":"Webhook Attempt Tools","depth":2}]},"contentItem":{"data":{"lastModified":"2026-05-14T19:02:55.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"30168294-7faa-5048-8640-2678cdcf88ea__redocly content/docs/mcp/tools/events-webhooks/","seo":{"title":"Events & Webhooks","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/mcp/tools/events-webhooks.md","pageBaseUrl":"/docs/mcp/tools/events-webhooks","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Events & Webhooks","id":"events--webhooks"},{"depth":2,"value":"Event Tools","id":"event-tools"},{"depth":2,"value":"Webhook Tools","id":"webhook-tools"},{"depth":2,"value":"Webhook Attempt Tools","id":"webhook-attempt-tools"}]},"data":{"title":""},"catalogInfo":null,"link":"/docs/mcp/tools/events-webhooks/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}