{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Coupling Webhooks","description":"Comprehensive API documentation for Zimark Integration platform. Learn how to seamlessly integrate and leverage Zimark's powerful features into your warehouse operations.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"__idx":0,"id":"coupling-webhooks"},"children":["Coupling Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Coupling webhooks are triggered by events related to coupling Zimarkers."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":1,"id":"overview"},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For coupling webhooks:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COUPLING"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["triggerName"]},": One of the available coupling events (see below)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]},": Contains the coupled pallet object or an error message"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For complete webhook structure and field descriptions, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/webhooks/webhooks"},"children":["Webhooks"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":2,"id":"available-events"},"children":["Available Events"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COUPLING_SUCCEEDED"]}," - Fired when a Zimarker is successfully coupled with a pallet ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COUPLING_FAILED"]}," - Fired when a Zimarker could not be coupled with a pallet ID"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":3,"id":"event-details"},"children":["Event Details"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":4,"id":"1.-coupling-succeeded-event"},"children":["1. Coupling Succeeded Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COUPLING_SUCCEEDED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fired when a Zimarker is successfully coupled with a pallet ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"category\": \"COUPLING\",\n    \"eventIdentifier\": \"134a7982-acac-4b20-8464-c49aa6900832\",\n    \"webhookUuid\": \"0ba817ee-bc3c-41c5-bd22-4b3f37e5620e\",\n    \"triggerName\": \"COUPLING_SUCCEEDED\",\n    \"triggerTime\": 1783267221955,\n    \"entityExternalId\": \"LPN0001234599\",\n    \"entityUuid\": \"327fbb17-2bbd-4587-bbf6-12cb2fc275c6\",\n    \"operationId\": \"cd5efdca-e4ba-42e6-9cc2-1dd66a9bcb5c\",\n    \"payload\": {\n        \"uuid\": \"327fbb17-2bbd-4587-bbf6-12cb2fc275c6\",\n        \"createDate\": 1783267221625,\n        \"updateDate\": 1783267221625,\n        \"deepLink\": \"https://67uo7.app.link/ysgphxjVw4b\",\n        \"trackCode\": \"001-111\",\n        \"wmsId\": \"LPN0001234599\",\n        \"status\": \"ACTIVE\",\n        \"zimarkCodes\": [\n            {\n                \"uuid\": \"ce71d0fb-177a-449c-b7e8-4345fd50966b\",\n                \"zimarkMarkerValue\": \"89\",\n                \"markerType\": \"ZMARKER\",\n                \"coupledAt\": 1783267221653\n            }\n        ],\n        \"manifests\": []\n    }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":5,"id":"2.-coupling-failed-event"},"children":["2. Coupling Failed Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COUPLING_FAILED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fired when a Zimarker could not be coupled with a pallet ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"category\": \"COUPLING\",\n    \"eventIdentifier\": \"3f4cdc9f-7e74-4924-862f-61dbe39b9a1c\",\n    \"webhookUuid\": \"0ba817ee-bc3c-41c5-bd22-4b3f37e5620e\",\n    \"triggerName\": \"COUPLING_FAILED\",\n    \"triggerTime\": 1783266610316,\n    \"entityExternalId\": \"LPN0001234599\",\n    \"entityUuid\": null,\n    \"operationId\": \"088869cf-883d-43ea-b620-e18395c5f002\",\n    \"payload\": {\n        \"failureReason\": \"Marker is being used in another track.\"\n    }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":6,"id":"payload-structure"},"children":["Payload Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For webhook header fields (category, eventIdentifier, triggerName, triggerTime, entityExternalId, entityUuid), see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/webhooks/webhooks"},"children":["Webhooks"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":7,"id":"coupling-success-payload"},"children":["Coupling Success Payload"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track UUID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unix timestamp when the track was created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updateDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unix timestamp when the track was last updated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trackCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track code identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wmsId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["WMS identifier (your pallet ID)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track status (ACTIVE, INACTIVE)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deepLink"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link to the Zimark Operational App"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["zimarkCodes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Zimarker(s) coupled to this track"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["zimarkCodes[].uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zimarker UUID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["zimarkCodes[].zimarkMarkerValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Zimarker code value"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["zimarkCodes[].markerType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Marker type used during coupling"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["zimarkCodes[].coupledAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unix timestamp when coupled"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["manifests"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Manifests this Zimarker is part of"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":8,"id":"coupling-failed-object"},"children":["Coupling Failed Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failureReason"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Coupling error message"]}]}]}]}]}]},"headings":[{"value":"Coupling Webhooks","id":"coupling-webhooks","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Available Events","id":"available-events","depth":2},{"value":"Event Details","id":"event-details","depth":2},{"value":"1. Coupling Succeeded Event","id":"1.-coupling-succeeded-event","depth":3},{"value":"2. Coupling Failed Event","id":"2.-coupling-failed-event","depth":3},{"value":"Payload Structure","id":"payload-structure","depth":2},{"value":"Coupling Success Payload","id":"coupling-success-payload","depth":3},{"value":"Coupling Failed Object","id":"coupling-failed-object","depth":3}],"frontmatter":{"seo":{"title":"Coupling Webhooks"}},"lastModified":"2026-07-05T23:34:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/webhooks/webhooks-coupling","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}