{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Gate 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":"gate-webhooks"},"children":["Gate Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Gate webhooks are triggered by events related to warehouse gates."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":1,"id":"overview"},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For gate 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":["GATE"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["triggerName"]},": One of the available gate events (see below)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload"]},": Contains the Gate object as returned by the Integration API"]}]},{"$$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":["GATE_STATUS_CHANGE"]}," - Fired when status changes between AVAILABLE, LOADING, OUT_OF_SERVICE"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_UNAUTHORIZED_LOADING_ADDED"]}," - Fired when unauthorized loading is added to the gate"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_UNAUTHORIZED_LOADING_RESOLVED"]}," - Fired when unauthorized loading is resolved (suppressed when resolution is due to status change to LOADING)"]}]},{"$$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.-gate-status-change-event"},"children":["1. Gate Status Change Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_STATUS_CHANGE"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fired when gate status changes between AVAILABLE, LOADING, and OUT_OF_SERVICE states."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"category\": \"GATE\",\n  \"webhookUuid\": \"92e1b4b0-2f7d-4cbd-8c0b-efc1a1b3f001\",\n  \"eventIdentifier\": \"evt-6c1d9f2a-7b04-4e51-9f3a-2a1c0b7d5e10\",\n  \"triggerName\": \"GATE_STATUS_CHANGE\",\n  \"triggerTime\": 1756124061881,\n  \"entityExternalId\": \"GATE-12A\",\n  \"entityUuid\": \"f1f6b1a7-4bde-4e7a-9c0c-0fcbab12d001\",\n  \"payload\": {\n    \"uuid\": \"ea1a1775-e9a4-4211-ae8d-1b3a6511de2a\",\n    \"createDate\": 1749649124552,\n    \"updateDate\": 1756289187591,\n    \"externalIdentifier\": \"GATE-12A\",\n    \"name\": \"Gate 12A\",\n    \"status\": \"LOADING\",\n    \"unauthorizedLoadings\": [],\n    \"unauthorizedLoadingsTruncated\": false,\n    \"totalUnauthorizedLoadingsCount\": 0\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":5,"id":"2.-gate-unauthorized-loading-added-event"},"children":["2. Gate Unauthorized Loading Added Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_UNAUTHORIZED_LOADING_ADDED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fired when unauthorized loading is added to a gate with status ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AVAILABLE"]},". This occurs when warehouse operators load items without an active manifest, creating a discrepancy between expected and actual loading operations."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"category\": \"GATE\",\n  \"webhookUuid\": \"e6a6fbe3-1ec5-4db1-9a42-7e7b1a0c9002\",\n  \"eventIdentifier\": \"evt-a29f7c14-3d8b-4c62-8e05-9b1f6a2d4c33\",\n  \"triggerName\": \"GATE_UNAUTHORIZED_LOADING_ADDED\",\n  \"triggerTime\": 1756124099999,\n  \"entityExternalId\": \"GATE-12A\",\n  \"entityUuid\": \"f1f6b1a7-4bde-4e7a-9c0c-0fcbab12d001\",\n  \"payload\": {\n    \"uuid\": \"ea1a1775-e9a4-4211-ae8d-1b3a6511de2a\",\n    \"createDate\": 1749649124552,\n    \"updateDate\": 1756289187591,\n    \"externalIdentifier\": \"GATE-12A\",\n    \"name\": \"Gate 12A\",\n    \"status\": \"AVAILABLE\",\n    \"unauthorizedLoadings\": [\n      {\n          \"uuid\": \"f907c4a7-0a57-4340-8ee8-6a4343284746\",\n          \"createDate\": 1756289223562,\n          \"updateDate\": 1756289223562,\n          \"track\": {\n              \"uuid\": \"39a64455-9ea9-4f74-8ef0-971ee16d35eb\",\n              \"trackCode\": \"000-130\",\n              \"wmsId\": \"local-33121364151\",\n              \"status\": \"ACTIVE\"\n          },\n          \"trackIdentifier\": \"local-33121364151\",\n          \"markerValue\": \"33121434156\",\n          \"loadedDate\": 1756289223031,\n          \"loadingStatus\": \"UNAUTHORIZED_LOADED\"\n      }\n    ],\n    \"unauthorizedLoadingsTruncated\": false,\n    \"totalUnauthorizedLoadingsCount\": 1\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":6,"id":"3.-gate-unauthorized-loading-resolved-event"},"children":["3. Gate Unauthorized Loading Resolved Event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_UNAUTHORIZED_LOADING_RESOLVED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fired when unauthorized loading is resolved."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Suppressed when resolution is due to status change to LOADING. In that case, only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_STATUS_CHANGE"]}," is emitted to prevent duplicate events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":7,"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":8,"id":"gate-payload-fields"},"children":["Gate Payload Fields"]},{"$$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":["Gate 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 gate 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 gate was last updated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gate external identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gate display name"]}]},{"$$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":["Gate status (AVAILABLE, LOADING, OUT_OF_SERVICE)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorizedLoadings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized loading events (descending by loadedDate, max 50 items)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorizedLoadingsTruncated"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the list is truncated due to 50-item limit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalUnauthorizedLoadingsCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total count of active unauthorized loadings (always present; use when the array is truncated)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":9,"id":"unauthorized-loading-object"},"children":["Unauthorized Loading 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":["uuid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized loading 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 loading 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 loading was last updated"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["track"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Track object with loading information"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trackIdentifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for the track"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["markerValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Marker identifier for tracking"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loadedDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unix timestamp when loaded"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["loadingStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current loading status (UNAUTHORIZED_LOADED, etc.)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"__idx":10,"id":"track-object"},"children":["Track 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":["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":["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 system identifier"]}]},{"$$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, etc.)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":11,"id":"event-suppression-rules"},"children":["Event Suppression Rules"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When resolving unauthorized items due to status change to LOADING:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Do NOT emit"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_UNAUTHORIZED_LOADING_RESOLVED"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Emit only"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GATE_STATUS_CHANGE"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This prevents duplicate events and provides complete state change information."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"__idx":12,"id":"payload-limits"},"children":["Payload Limits"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorizedLoadings"]}," array is capped at 50 items"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unauthorizedLoadingsTruncated: true"]},", use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalUnauthorizedLoadingsCount"]}," for full scope"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use additional API calls if you need access to all unauthorized loadings"]}]}]},"headings":[{"value":"Gate Webhooks","id":"gate-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. Gate Status Change Event","id":"1.-gate-status-change-event","depth":3},{"value":"2. Gate Unauthorized Loading Added Event","id":"2.-gate-unauthorized-loading-added-event","depth":3},{"value":"3. Gate Unauthorized Loading Resolved Event","id":"3.-gate-unauthorized-loading-resolved-event","depth":3},{"value":"Payload Structure","id":"payload-structure","depth":2},{"value":"Gate Payload Fields","id":"gate-payload-fields","depth":3},{"value":"Unauthorized Loading Object","id":"unauthorized-loading-object","depth":3},{"value":"Track Object","id":"track-object","depth":3},{"value":"Event Suppression Rules","id":"event-suppression-rules","depth":2},{"value":"Payload Limits","id":"payload-limits","depth":2}],"frontmatter":{"seo":{"title":"Gate Webhooks"}},"lastModified":"2026-07-05T23:34:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/webhooks/webhooks-gate","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}