Skip to main content

Developer resources v1

Coilinx API

Read-only inventory sync and signed operational webhooks.

Webhooks

Coilinx sends HTTPS POST requests when subscribed inventory changes occur. Manage endpoints in Account → Integrations → Webhooks.

Event types

| Event | Trigger | | --- | --- | | inventory.item.created | An item is added | | inventory.item.updated | Item measurements, name, type, or location metadata changes | | inventory.item.archived | An item is archived | | inventory.item.checked_out | An item is checked out | | inventory.item.returned | A checked-out item is returned | | inventory.item.transferred | An item moves between locations | | inventory.type.updated | A material type changes | | inventory.location.updated | Location metadata changes |

Payload

{
  "eventId": "evt_01abc",
  "type": "inventory.item.checked_out",
  "occurredAt": "2026-07-14T15:32:10Z",
  "companyId": "cmp_01abc",
  "endpointId": "whk_01abc",
  "data": {
    "id": "itm_01abc",
    "name": "Spool A-12",
    "status": "checked_out",
    "locationId": "wh_01abc",
    "materialTypeId": "mat_01abc",
    "remainingLength": 842.5,
    "weight": 12.4,
    "weightSource": "scale",
    "checkedOutToUserId": "usr_01abc",
    "checkedOutAt": "2026-07-14T15:32:10Z",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-07-14T15:32:10Z"
  }
}

Use the payload as a notification. For authoritative current state, fetch the resource from the API by ID.

Delivery contract

  • Respond with any 2xx status within ten seconds.
  • Coilinx retries network errors, 408, 425, 429, and 5xx responses.
  • Events are delivered at least once and can arrive more than once.
  • Use X-Coilinx-Event-Id (also present as eventId) as an idempotency key.
  • Do not depend on strict ordering across endpoints or resources.

Recommended handler

  1. Read the unmodified raw request body.
  2. Verify X-Coilinx-Signature.
  3. Check whether eventId was processed previously.
  4. Enqueue the event in your own system.
  5. Return 200 immediately.
  6. Process the business action asynchronously.

See signature verification for complete Node and Python examples.