🛎 Notifications & Webhooks

Want to know who is entering your world? Get informed on who is coming in and what is being reported in your world.

Notifications
📌 Enable Doorbell Notifications
🛎 Allow Guests to Subscribe to your Doorbell
🔔 Subscribe to Push Notifications

Webhooks
🪝 World Webhook
🪤 Interactive Asset Webhooks
👋 Using a Webhook for People Joining the World
🪟 Using a Webhook to Manage the Waitlist
🆘 Using a Webhook for Moderation

📌 Enable Doorbell Notifications

Receive a notification when someone enters your world. By adding a doorbell to your world you can be notified anytime someone enters your world. This feature makes it easy to greet your guests!

You can subscribe to your world notifications by following these simple steps:

Enter your Topia world
Click the Preferences icon at the top of the toolbar
On the bottom of the Preferences page, click the toggle under World Notifications. When turned on, the toggle will show a check mark highlighted in blue
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer

*In order for the doorbell to work, you must enable notifications within the browser.

🛎 Allow Guests to Subscribe to Your Doorbell

As a world owner, you can also allow other guests & members of your community to receive notifications for your world. The doorbell will send a push notification through your browser anytime someone enters your world. To do this follow these simple steps:

Enter your Topia world.
Click the World Settings icon
Under World Configurations click Guest Controls
In the Guest Controls page, click the toggle under Allow Guest Notifications. When turned on, the toggle will show a check mark highlighted in blue
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer

*By enabling this setting, any guest who visits your world can choose to receive push notifications for your world.

🔔 Subscribe to Push Notifications

As a guest or administrator in a world, you can subscribe to receive doorbell notifications if the World Owner has enabled the option, here's how:

Enter your Topia world
Click on the My Account icon at the top of the toolbar
On the bottom of the Settings page, click the toggle under World Notifications. When turned on, the toggle will show a check mark highlighted in blue
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer

*If this option is disabled, the World Owner may not have enabled this option for guests in the world.

Enable Push Notifications in the Browser

In order to receive doorbell notifications, notifications must be enabled within your browser for Topia.io. To do this, access the browser settings menu:

Check that the notifications settings for Topia.io are set to "Ask (Default)"
Disable any browser extensions that may block notifications (you can use an incognito or private browser window to do so)

🪝 Webhooks

By using a webhook service like Zapier, you can get alerted via email, text message or even a notification on Slack when someone comes into your world. or performs a trigger action.

🪝 Add a World Webhook

Enter your Topia world
Click the World Settings icon
Under World Settings click Notifications & Webhooks
In the Notification & Webhooks page, click Add Webhook
Choose the Webhook Type that matches the action being captured:
- User Joins World
- User Waitlisted
- User Reported
Enter a title and description so you can find it later
Enter the webhook URL and use the toggle if you want to limit the webhook to trigger only once per user per day
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer
Topia will send data to this webhook when somebody triggers the action

🪤 Add a Webhook to an Interactive Asset (two ways)

Enter your Topia world
Make sure Edit Mode is on and the Edit toggle on the toolbar is blue
Hover over the asset you want to trigger a webhook and click the pencil icon
Click Edit from the drop down menu to open the Modify Asset drawer
Option 1: Click Integrations
- In the Integrations page, click Add Webhook
- Choose the Webhook Type that matches the action attributed to the asset:
  - Private Zone Entered
  - Broadcast Zone Entered
  - Media Played
  - Media Play Finished
  - Asset Clicked
  - Webhook Zone Entered
  - Webhook Zone Exited
Option 2: Click Zones
- Check a Zone type
- Click Add Webhook
- Choose a Webhook Type from the drop-down (this list will change based on the zone selected)

Enter a title and description so you can find it later
Enter the webhook URL and use the toggle if you want to limit the webhook to trigger only once per user per day
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer
Topia will send data to this webhook when somebody interacts with that asset

👋 Using a Webhook for People Joining the World

Want to get a notification the instant a person enters your world? We have you covered! By using a webhook, you can be get an alert as soon as a guest enters or monitor when brand new guests arrive.

Enter your Topia world
Click the World Settings icon
Under World Settings click Notifications & Webhooks
In the Notifications & Webhooks, click Add Webhook
Under Webhook Type, choose User Joins World
Enter a title and description so you can find it later
Enter the webhook URL and use the toggle if you want to limit the webhook to trigger only once per user per day
Collapse the page by clicking the ❘← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer

🚪 Using a Webhook to Manage the Waitlist

Hosting a popular event in a world with a capacity limit? You can use a webhook to get alerted when a person is waiting to join because the world is currently at capacity. The webhook will deliver the display name of the guest waitlisted and the URL of the world who's capacity has been reached.

Enter your Topia world
Click the World Settings icon
Under World Settings click Notifications & Webhooks
In the Notification & Webhooks page, click Add Webhook
Under the Webhook Type, choose User Waitlisted
Enter a title and description so you can identify the webhook it later
Enter the webhook URL and use the toggle if you want to limit the webhook to trigger only once per user per day
Collapse the page by clicking the ❘ ← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer
Topia will send data to this webhook when somebody joins the world

🆘 Using a Report Webhook for Moderation

A report webhook can be used to get an alert when a person in the world is being reported by another guest. The webhook will deliver the display name of the guest and reported person, the reason for the report, and a URL to the exact coordinates where the report happened. This can be very useful when moderating a public world, allowing the world owner or admins the ability to respond to situations quickly.

A report webhook can be added by doing the following:

Click the World Settings icon
Under World Settings click Notifications & Webhooks
In the Notification & Webhooks page, click Add Webhook
Under the Webhook Type, choose User Reported
Enter a title and description so you can identify the webhook it later
Enter the webhook URL and use the toggle if you want to limit the webhook to trigger only once per user per day
Collapse the page by clicking the ❘ ← icon in the top right corner or close the page and drawer by clicking on the ✕ in the drawer
Topia will send data to this webhook when somebody joins the world