<aside> 💡 *this function is not yet available for public consumption

</aside>

Introduction

The Virtually Events API provides event infrastructure as a service.

Features

• Create events and send calendar invites
• Track attendance and engagement by event and individuals
• Send automated reminders prior to the start of a session and post-session feedback surveys like this one to attendees

Initial Setup

As we develop our API, we'll collaborate closely with you on this Notion document. Once we have something that works well for you, we'll move over an API documentation platform (like Postman or Readme).

Getting a token

Log in with your Virtually credentials at this endpoint:

curl --location --request POST '<https://app.tryvirtually.com/api/v1/auth/login>' \\
  --user **<your-email>** \\
  --header 'Content-Type: application/json'

You'll be prompted to enter a password. Enter the one associated with your Virtually account. This option obscures your password, which is useful if you're screen sharing or don't want to save your account password in your CLI history. If you're working in a secure environment and don't mind your password showing up in your bash history, you can run:

curl --location --request POST '<https://app.tryvirtually.com/api/v1/auth/login>' \\
  --user **<your-email>:<your-password>** \\
  --header 'Content-Type: application/json'

In either case, you should see a response like the following: