Skip to content

Commit

Permalink
Update api-doc
Browse files Browse the repository at this point in the history
Adding some titles to get the anchors to work and show up in the Navigation
  • Loading branch information
brumoen authored Jan 4, 2025
1 parent 8a4257e commit a93851a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/app/v5/api/contacts/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@
* [**/queues/:queueId/toggle** `POST`](#post-queuesqueueidtoggle)
* [**/queues/:queueId/clear** `GET`](#get-queuesqueueidclear)
* [**/queues/:queueId/clear** `POST`](#post-queuesqueueidclear)
- [WebSocket Endpoint](#ws-endpoint)
- [WebSocket Endpoint](#websocket-endpoint)

# Overview
## Overview
Firebot hosts a local API that developers can use to get data from Firebot or tell it to run effects.
* The API is hosted on port **7472**. All endpoints have the root **http://localhost:7472/api/v1**
* All responses are in JSON.
* Don't forget that Firebot must be running for the API to be available.

# Endpoints
## Rest Endpoints

## Authentication

Expand Down Expand Up @@ -1622,7 +1622,7 @@ POST /queues/queue1/clear
"status": "removed"
}
```
# WS Endpoint
## WebSocket Endpoint
Firebot hosts a local Websocket API that developers can use to get data from Firebot.
* The API is hosted on port **7472**. All endpoints have the root **ws://localhost:7472/api/v1**
* All responses are in JSON.
Expand Down

0 comments on commit a93851a

Please sign in to comment.