For advanced users that may be setting up a Gatherly event via iframe following this guide, the documentation below covers how you can configure additional properties of individual links to set a fields such as a user's name or title.

Many aspects of the user's properties (floor access, starting floor, admin/broadcast permissions, avatar color) can be set via the account setup portal.

Questions? Email sohan@gatherly.io.

Format

https://<YOUR EVENT>.event.gatherly.io/?<QUERY PARAM>=<VALUE>&...

Example

https://abc.event.gatherly.io/
?name=U29oYW4=
&title=RW5naW5lZXI%3D
&color=IzAwMkZBRg%3D%3D
&allowedFloors=WzAsMl0%3D
&floorNum=Mg%3D%3D
&broadcast=true
&uuid=2VqasQVFxczaxmTZQxzuRS

Query params

Most of the query parameters use base64-encoded values. You can use btoa(encodeURIComponent(value)) to base64-encode a string in the browser.

name

Prefill the user’s name in onboarding.

Value: encoded string (e.g. btoa(encodeURIComponent(“Zach”)) -> “U29oYW4=”)

title

Prefill the user’s title in onboarding.

Value: encoded string (e.g. btoa(encodeURIComponent(“Engineer”)) -> “RW5naW5lZXI=”)

allowedFloors

List of floors that the user’s allowed to visit.

Value: base64-encoded, stringified array of whole numbers (e.g. [0,2] -> “WzAsMl0=”), must contain first floor (0)

floorNum

The floor that the user starts on.

Value: base64-encoded stringified whole number (e.g. 2 -> “Mg==”), must be a floor that the user has access to

broadcast

Whether user wants admin / broadcast permissions.

Value: “true” or “false” (default: “false”)

uuid

Unique event-specific value that must be provided with broadcast=true to grant user admin / broadcast permissions.

Value: string (e.g. "2VqasQVFxczaxmTZQxzuRS")