Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
📝 Add the Zoom integration guide (#3371)
Luke Vellad19811997c59
diff --git a/apps/docs/images/integrations/zoom/add-location-menu.png b/apps/docs/images/integrations/zoom/add-location-menu.pngnew file mode 100644index 000000000..bb9a6454dBinary files /dev/null and b/apps/docs/images/integrations/zoom/add-location-menu.png differdiff --git a/apps/docs/images/integrations/zoom/connect-account.png b/apps/docs/images/integrations/zoom/connect-account.pngnew file mode 100644index 000000000..19003f325Binary files /dev/null and b/apps/docs/images/integrations/zoom/connect-account.png differdiff --git a/apps/docs/images/integrations/zoom/connected-account.png b/apps/docs/images/integrations/zoom/connected-account.pngnew file mode 100644index 000000000..616b8caf7Binary files /dev/null and b/apps/docs/images/integrations/zoom/connected-account.png differdiff --git a/apps/docs/images/integrations/zoom/disconnect-menu.png b/apps/docs/images/integrations/zoom/disconnect-menu.pngnew file mode 100644index 000000000..9eab696ccBinary files /dev/null and b/apps/docs/images/integrations/zoom/disconnect-menu.png differdiff --git a/apps/docs/images/integrations/zoom/poll-page.png b/apps/docs/images/integrations/zoom/poll-page.pngnew file mode 100644index 000000000..1069c1877Binary files /dev/null and b/apps/docs/images/integrations/zoom/poll-page.png differdiff --git a/apps/docs/images/integrations/zoom/zoom-not-connected.png b/apps/docs/images/integrations/zoom/zoom-not-connected.pngnew file mode 100644index 000000000..6a6c54f2bBinary files /dev/null and b/apps/docs/images/integrations/zoom/zoom-not-connected.png differdiff --git a/apps/docs/images/integrations/zoom/zoom-selected.png b/apps/docs/images/integrations/zoom/zoom-selected.pngnew file mode 100644index 000000000..04276ae8dBinary files /dev/null and b/apps/docs/images/integrations/zoom/zoom-selected.png differdiff --git a/apps/docs/integrations/zoom.mdx b/apps/docs/integrations/zoom.mdxnew file mode 100644index 000000000..670118ac0--- /dev/null+++ b/apps/docs/integrations/zoom.mdx@@ -0,0 +1,144 @@+---+icon: video+title: Zoom+description: Connect your Zoom account so Rallly creates the meeting link when you finalize a poll+---++With the Zoom integration, Rallly creates a Zoom meeting on your account at the moment you finalize a poll. The join link goes into the event, the calendar invite and the confirmation emails, so participants never wait for a link to follow.++## How it works++1. You connect your Zoom account once, from your settings.+2. When you create a poll, you choose Zoom as the video call. The poll shows "Zoom" to participants while voting is open; there is no link yet.+3. When you finalize the poll, Rallly creates a Zoom meeting for the chosen time on your Zoom account and attaches the join link to the event.++The meeting is created on the Zoom account you connected, so it follows that account's settings, such as waiting rooms, passcodes and recording defaults. Rallly does not change those settings.++## Requirements++- A Zoom account. A free Zoom plan is enough.+- The Zoom integration must be enabled on the Rallly instance you use. On rallly.co it is available to all accounts; on a self-hosted instance the administrator turns it on.+- Finalizing a poll is a Pro feature on rallly.co. Connecting Zoom and choosing it for a poll works on every plan; the meeting is created when the poll is finalized.++## Adding the app++<Steps>+ <Step title="Open Conferencing settings">+ In Rallly, open **Settings** from the sidebar and choose **Conferencing**.+ </Step>+ <Step title="Connect your account">+ Click **Connect account** and choose **Zoom**. You are sent to Zoom to sign in and approve the connection.++<Frame>+ <img src="/images/integrations/zoom/connect-account.png" alt="The Conferencing settings page with the Connect account menu open, showing Zoom and Google Meet" />+</Frame>+ </Step>+ <Step title="Approve the permissions">+ Zoom shows what Rallly is asking for (listed under [Permissions](#permissions)). Click **Allow**. You are returned to Rallly and your Zoom account appears in the list of connected accounts.++<Frame>+ <img src="/images/integrations/zoom/connected-account.png" alt="The Conferencing settings page listing a connected Zoom account" />+</Frame>+ </Step>+</Steps>++You can connect one Zoom account per Rallly account. To switch to a different Zoom account, remove the current one first.++## Using the integration++### Choosing Zoom for a poll++When creating a poll, click **Add location** and choose **Zoom** under **Video call**.++<Frame>+ <img src="/images/integrations/zoom/add-location-menu.png" alt="The Add location menu on the poll form, with Address under In-person and Zoom, Google Meet and Custom under Video call" />+</Frame>++The form shows "Zoom" as the video call for this poll.++<Frame>+ <img src="/images/integrations/zoom/zoom-selected.png" alt="The poll form with Zoom chosen as the video call" />+</Frame>++If your Zoom account is not connected, the form tells you so and links to Conferencing settings.++<Frame>+ <img src="/images/integrations/zoom/zoom-not-connected.png" alt="The poll form showing the message that Zoom is not connected, with a link to Conferencing settings" />+</Frame>++Participants see "Zoom" on the poll page while voting is open. No meeting exists yet.++<Frame>+ <img src="/images/integrations/zoom/poll-page.png" alt="The poll page showing Zoom under the organizer on the event card" />+</Frame>++### Finalizing the poll++When you finalize the poll and pick the winning time, Rallly:++1. Creates a scheduled Zoom meeting on your account for that date and time, using the poll title as the meeting topic.+2. Attaches the join link to the event.+3. Includes the link in the calendar invite (`.ics`) and in the confirmation emails sent to you and to participants.++The meeting also appears in your Zoom account under **Meetings**, where you can edit or delete it like any other meeting.++If the meeting cannot be created, for example because the Zoom connection has expired, the poll stays open and Rallly shows an error. Reconnect your account in Conferencing settings and finalize again.++### Which account hosts the meeting++The meeting is created on the Zoom account of the poll's organizer. If a space member finalizes a poll organized by someone else, the meeting is still created on the organizer's Zoom account.++## Permissions++When you connect, Rallly asks Zoom for these permissions:++| Permission | Why |+| --- | --- |+| View your user information (`user:read:user`) | To show which Zoom account is connected, by name and email, and to tell accounts apart. |+| Create meetings (`meeting:write:meeting`) | To create the meeting when you finalize a poll. |++Rallly does not read your existing meetings, recordings, contacts or chat, and does not join or record meetings.++## Data Rallly stores++For a connected Zoom account, Rallly stores:++- Your Zoom account id, display name and email address, to show the connection in your settings.+- The access token and refresh token Zoom issues, encrypted at rest, so Rallly can create meetings on your behalf without asking you to sign in each time.++For each finalized poll, Rallly stores the meeting id, join link and passcode of the meeting it created, as part of the event.++Rallly does not store the content of any meeting.++## Removing the app++### From Rallly++1. Open **Settings**, then **Conferencing**.+2. On your Zoom account, click the **More options** button and choose **Disconnect**.++<Frame>+ <img src="/images/integrations/zoom/disconnect-menu.png" alt="The connected Zoom account with its menu open, showing Disconnect" />+</Frame>++The connection is removed immediately. Polls that already chose Zoom keep that choice but can no longer be finalized with a Zoom link until an account is connected again. Meetings Rallly already created stay in your Zoom account; delete them from Zoom if you no longer need them.++### From Zoom++You can also remove the app from the Zoom side:++1. Sign in to the [Zoom App Marketplace](https://marketplace.zoom.us/).+2. Click **Manage**, then **Added Apps**.+3. Find **Rallly** and click **Remove**.++Removing the app from Zoom revokes Rallly's access. Disconnect the account in Rallly as well so it no longer appears in your settings.++## Troubleshooting++**"Zoom is not connected" when creating a poll.** Your Rallly account has no Zoom connection, or it was removed. Connect one in Conferencing settings and choose Zoom again.++**Finalizing fails with a video call error.** The Zoom connection has expired or was revoked on the Zoom side. Disconnect and reconnect the account, then finalize again. The poll is unchanged until finalizing succeeds.++**The meeting was created on the wrong account.** The meeting is always created on the poll organizer's connected Zoom account. Check which account is connected in Conferencing settings.++Still stuck? [Contact support](/contact/support).