---
title: "Set Websocket"
method: POST
path: "/websocket/set/{instance}"
tags: ["Websocket Controller"]
---

# Set Websocket

`POST /websocket/set/{instance}`

## Request

- Base URL: `https://evolution-example`
- URL: `https://evolution-example/websocket/set/{instance}`
- Auth: API key in header `apikey`

Set Websocket

## Path parameters

- `instance` string, required

## Request body

- object
  - `websocket` object, required
    - `enabled` boolean
    - `events` string[]: Events to be sent to the websocket

## Response `200`

Ok

## Changes

- **2024-11-25** (v2) `a85700e7a400`: 1 breaking, 2 warning
  - added the new required request property `websocket`
  - removed the request property `enabled`
  - removed the request property `events`
- **2024-11-25** (v2) `c153448703e5`: 1 breaking, 6 info
  - removed the media type `application/json` for the response with the status `200`
  - api operation id `setWebsocket` was added
  - the endpoint scheme security `ApiKeyAuth` was added to the API
  - api tag `Websocket Controller` added
  - …3 more
- **2024-09-09** (v2) `0c4620ca5ed5`: 2 warning, 5 info
  - removed the request property `enabled`
  - removed the request property `events`
  - api operation id `setWebsocket` removed and replaced with ``
  - the endpoint scheme security `ApiKeyAuth` was removed from the API
  - …3 more

[Operation history](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/changes/websocket/set/:instance/post.md)

---

[API](https://skmtc.dev/evolution-foundation/apis/evolution-api-3.md) - [All operations](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/llms.txt) - [OpenAPI document](https://skmtc.dev/evolution-foundation/apis/evolution-api-3/revisions/153363ee7f38?raw)