---
title: "Register a new WebSocket integration"
method: PUT
path: "/epos/integrations/ws"
tags: ["Capabilities"]
---

# Register a new WebSocket integration

`PUT /epos/integrations/ws`

## Request

- Base URL: `https://api.dojo.tech`
- URL: `https://api.dojo.tech/epos/integrations/ws`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dojo/apis/dojo-api/docs/epos/integrations/ws/put.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- WsIntegrationRequest: WebSockets request
  - `capabilities` WsCapabilityRequest[], required: Send a WS request
    - `name` string, required: The name of a capability. (CancelOrderById, CreateOrder, ListAreas, GetOrderById, SearchTables, HandleEvent:payment_intent.created, HandleEvent:payment_intent.status_updated, HandleEvent:terminal_session.created, HandleEvent:terminal_session.status_updated, HandleEvent:terminal_session.signature_verification_required, HandleEvent:terminal_session.notification, SearchOrders, GetPartyById, DeletePartyById, SearchParties, UpdateParty, CreateParty, GetReservationById, SearchReservations, UpdateReservation, DeleteReservationById, CreateReservation, RecordOrderPaymentById, CreateOrderLock, DeleteOrderLock, ExtendOrderLock, GetOrderBillById)
    - `version` string, required

## Response `200`

Successful operation

- WsIntegrationResponse[]
  - `capabilities` CapabilityResponse[], required: Receive a response to a WS request
    - `name` string, required
    - `version` string, required
    - `updatedAt` string, date-time, required
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/dojo/apis/dojo-api.md) - [All operations](https://skmtc.dev/dojo/apis/dojo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dojo/apis/dojo-api/revisions/29fc8900ba37?raw)