---
url: /apidocs/social_event.md
---
## Social events API

API allows to hold events, where users can create sessions, invite participants, join public session of other users and meet in videochat conference.

| Endpoint | Method | Description |
|-----|-----|-----|
| [/api/v0/resource/sessionInvitation/{sessionId}](#get-ics-file-for-social-invitation) | webRequest | Get ICS file for social invitation |
| [social:createEvent](#create-social-event) | websocket | Create social event |
| [social:updateEvent](#update-social-event) | websocket | Update social event |
| [social:publishEvent](#publish-social-event) | websocket | Publish social event |
| [social:deleteEvent](#delete-social-event) | websocket | Delete social event |
| [social:getEvent](#get-social-event) | websocket | Get social event |
| [social:getEvents](#get-social-events) | websocket | Get social events |
| [social:createSession](#create-social-session) | websocket | Create social session |
| [social:updateSession](#update-social-session) | websocket | Update social session |
| [social:deleteSession](#delete-social-session) | websocket | Delete social session |
| [social:getSession](#get-social-session) | websocket | Get social session |
| [social:getSessions](#get-social-sessions) | websocket | Get social sessions |
| [social:getPropSessions](#get-prop-social-sessions) | websocket | Get prop social sessions |
| [social:inviteUsersToSession](#invite-users-to-social-session) | websocket | Invite users to social session |
| [social:deleteUserSessionInvitations](#delete-user-social-session-invitations) | websocket | Delete user social session invitations |
| [social:joinSession](#join-social-session) | websocket | Join social session |
| [social:declineSessionJoin](#decline-social-session-join) | websocket | Decline social session join |
| [social:sessionUpdated](#on-social-session-updated-event) | websocketEvent | On social session updated event |
| [social:sessionDeleted](#on-social-session-deleted-event) | websocketEvent | On social session deleted event |

### Get ICS file for social invitation

**HTTP Method:** GET

**Path:** /api/v0/resource/sessionInvitation/{sessionId}

**Description:** Endpoint returns ICS file for social session invitation.

If session doesn't exist or user doesn't have permissions for social invitation, endpoint returns status code 404 Not Found.

**Request:**

**Response:**

### Create social event

**Method:** websocket

**Endpoint:** social:createEvent

**Description:** Available sources for social events:

* Network event - `network:{networkId}`
* Community event - `community:{networkId}:{communityId}`

**Request:**

**Response:**

### Update social event

**Method:** websocket

**Endpoint:** social:updateEvent

**Request:**

**Response:**

### Publish social event

**Method:** websocket

**Endpoint:** social:publishEvent

**Request:**

**Response:**

### Delete social event

**Method:** websocket

**Endpoint:** social:deleteEvent

**Request:**

**Response:**

### Get social event

**Method:** websocket

**Endpoint:** social:getEvent

**Request:**

**Response:**

### Get social events

**Method:** websocket

**Endpoint:** social:getEvents

**Request:**

**Response:**

### Create social session

**Method:** websocket

**Endpoint:** social:createSession

**Request:**

**Response:**

### Update social session

**Method:** websocket

**Endpoint:** social:updateSession

**Request:**

**Response:**

### Delete social session

**Method:** websocket

**Endpoint:** social:deleteSession

**Request:**

**Response:**

### Get social session

**Method:** websocket

**Endpoint:** social:getSession

**Request:**

**Response:**

### Get social sessions

**Method:** websocket

**Endpoint:** social:getSessions

**Request:**

**Response:**

### Get prop social sessions

**Method:** websocket

**Endpoint:** social:getPropSessions

**Description:** API returns 2 nearest events (ongoing or future).

**Request:**

**Response:**

### Invite users to social session

**Method:** websocket

**Endpoint:** social:inviteUsersToSession

**Request:**

**Response:**

### Delete user social session invitations

**Method:** websocket

**Endpoint:** social:deleteUserSessionInvitations

**Request:**

**Response:**

### Join social session

**Method:** websocket

**Endpoint:** social:joinSession

**Request:**

**Response:**

### Decline social session join

**Method:** websocket

**Endpoint:** social:declineSessionJoin

**Request:**

**Response:**

### On social session updated event

**Event:** social:sessionUpdated

**Data:**

### On social session deleted event

**Event:** social:sessionDeleted

**Data:**

## Models

#### RGBA

#### User Simple