# SSTI Server API Reference

This page lists all available SSTI Server API events and commands. For a general API overview, [click here](/doc/1cdd965d-2073-4e3e-9cd4-430ae768ab3c).

## SSTI Box API Reference

| Command/Event | Description |     |
|---------------|-------------|-----|
| \### Commands |             |     |
| [SSTI_SERV_API_GET_GROUP](/doc/658f9c54-0ba9-4f6b-afc0-63cb9b8f8cbf) | Requests the name of the group SSTI currently manages. |     |
| [SSTI_SERV_API_GET_CLOUD](/doc/62a8a562-2470-4498-b46c-3decd6c9eb80) | Get the current SSTI cloud group number. |     |
| [SSTI_SERV_API_BOX_CUSTOM_BUTTON](/doc/5711d58f-4eb3-4d4a-8ae9-2988fe16b00d) | Requests all connected SSTI boxes to set the title of unused menu button (usually marked with "--"). |     |
| [SSTI_SERV_API_GET_PARAM](/doc/9e540581-ce84-4ca1-900d-e2ad1118ab6f) | Allows requesting your own custom variables from [SSTI Config Notecard](/doc/b1c493d0-6f1a-4ae0-aa26-1f33b933c13c). |     |
| \### Events   |             |     |
| [SSTI_SERV_EVENT_INITIALIZED](/doc/45ce557b-3520-453e-8f21-3bf6deb1596f) | Event fires when SSTI receives the new configuration from server (for example, on group name change). |     |
| [SSTI_SERV_EVENT_GROUP](/doc/ab39cbd9-28b1-4a88-8953-33cfa44d8205) | SSTI server sends us the group name (either by our request or after reading its config). |     |
| [SSTI_SERV_EVENT_CLOUD](/doc/a5b831dd-134a-4960-bc3d-fcdfa06246c5) | SSTI server sends us the cloud # (either by our request or after reading its config). |     |
| [SSTI_SERV_EVENT_BOX_CUSTOM_BUTTON](/doc/b0a9c186-a13b-496d-bedc-1222e38125cd) | Tenant has clicked on custom menu button in box pop-up menu. |     |
| [SSTI_SERV_EVENT_PARAM](/doc/65cfb3d9-19ae-4896-82b5-5840176f05b6) | Returns the previously requested custom config variable value. |     |
| [SSTI_SERV_EVENT_RESET](/doc/5abf00a4-c1e8-4cef-b441-30f0a531216b) | Event fires when SSTI main script has just restarted. |     |
| [SSTI_SERV_EVENT_TENANT](/doc/6761d47b-e9b5-48ab-bfaa-e6a9c02a6638) | SSTI-powered Hippo box just got a new tenant. |     |
| [SSTI_SERV_EVENT_NEW_GUESTPARTNER](/doc/547fa224-45c0-4470-b477-9fd6ae237229) | Tenant adds the new guest or partner to his box. |     |
| [SSTI_SERV_EVENT_GUESTPARTNER_REMOVED](/doc/bea58b9d-9bb7-4b6c-8a6a-c35f0b686bc5) | Tenant just removed one of his guests/partners from the list. |     |

---

**Documents**

- [SSTI_EVENT_CUSTOM_BUTTON (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_event_custom_button-ssti-api-event-Vd0tt1PO4K)
- [SSTI_EVENT_NEW_TENANT (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_event_new_tenant-ssti-api-event-4F2I3dBOa2)
- [SSTI_API_BOX_CUSTOM_BUTTON (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_api_box_custom_button-ssti-api-command-1cfMp3DO9X)
- [SSTI_SERV_API_GET_CLOUD (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_api_get_cloud-ssti-api-command-yUGILfXW9f)
- [SSTI_SERV_API_GET_GROUP (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_api_get_group-ssti-api-command-mU29aGf1XS)
- [SSTI_SERV_EVENT_GROUP (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_group-ssti-api-event-bbNdnwpuy0)
- [SSTI_SERV_EVENT_GUESTPARTNER_REMOVED (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_guestpartner_removed-ssti-api-event-XT8f0Db4ex)
- [SSTI_SERV_EVENT_INITIALIZED (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_initialized-ssti-api-event-lkv7wkCTwa)
- [SSTI_API_GET_PARAM (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_api_get_param-ssti-api-command-LxZzxh1Fo8)
- [SSTI_SERV_EVENT_BOX_CUSTOM_BUTTON (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_box_custom_button-ssti-api-event-audPzW0eVY)
- [SSTI_SERV_EVENT_CLOUD (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_cloud-ssti-api-event-jyBryL5EEJ)
- [SSTI_API_CUSTOM_BUTTON (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_api_custom_button-ssti-api-command-MklacdiXUH)
- [SSTI_API_GET_GUESTS (SSTI API Command)](https://www.mysmartbots.com/docs/s/main/doc/ssti_api_get_guests-ssti-api-command-dN5K0r9Ofd)
- [SSTI_SERV_EVENT_NEW_GUESTPARTNER (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_new_guestpartner-ssti-api-event-nMqC4BPi9I)
- [SSTI_SERV_EVENT_TENANT (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_tenant-ssti-api-event-6gz1TQDNt3)
- [SSTI_SERV_EVENT_PARAM (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_param-ssti-api-event-jryQYJM77h)
- [SSTI_SERV_EVENT_RESET (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_serv_event_reset-ssti-api-event-NCwzNZ8sCv)
- [SSTI_EVENT_GUESTS (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_event_guests-ssti-api-event-Logcip8gsZ)
- [SSTI_EVENT_INITIALIZED (SSTI API Event)](https://www.mysmartbots.com/docs/s/main/doc/ssti_event_initialized-ssti-api-event-nrrZH9pbch)