Skip to content
Contact Support
  • There are no suggestions because the search field is empty.

🛎  Notifications & Webhooks

Set Up and Subscribe to Real-Time Alerts using Notifications and Webhooks

circleCheckSubscribe to Push Notifications

circleCheck

Enable Push Notifications in your Browser

circleCheck

Allow Users to Subscribe to Push Notifications

circleCheck

Get Real-Time Alerts with Webhooks

circleCheck

Learn about World Webhooks

circleCheck

Add a World Webhook

circleCheck

Learn about Asset Webhooks

circleCheck

Add an Asset Webhook

 

 

Subscribe to Push Notifications

Receive a notification when an admin opens the world. You can subscribe to this world notification by following these simple steps:

To Subscribe to Push Notifications:
  1. Enter the Topia world
  2. In the left sidebar, click My Account
  3. At the bottom under World Settings, you'll see a toggle for World open alert:
    • Toggle On to be notified when the world is opened
    • Toggle Off to silence these notifications

 

Enable Push Notifications in the Browser

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

To Enable Push Notifications in your Browser:
  1. Open your browser settings menu
  2. Locate Site Settings for Topia.io
  3. Set Notifications Settings to "Ask" or "Allow"
  4. Disable any browser extensions that may block notifications or use an incognito or private browser window 

 

Allow Users to Subscribe to your World Push Notifications

As a world owner, you can also allow other users and 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 Enable or Disable Users' Ability to Subscribe to Push Notifications:
  1. Enter your Topia world
  2. In the left sidebar, click World Settings settings → Integrations
  3. Under Notifications, click the World Push Notifications dropdown menu and select an option:
    • Disable for All to prevent all users from subscribing to push notifications
    • Admins Only to only allow admins to subscribe to push notifications
    • All Users to allow all users the ability to subscribe to push notifications

 

 

Webhooks

By using a webhook service like Zapier, you can receive alerts about activity in your world via email, text message, or even a notification on Slack.

 

World Webhooks

These webhooks are set up at the world level. They are not triggered based on a specific location in the world.

Use Cases for World Webhooks

circleCheckGet a real-time alert when someone joins your world

circleCheck

Track a waitlist for your event when your world is at capacity and more people are trying to enter

circleCheck

Get a real-time alert when a user is reported in your world to assist with moderation

 

World Webhook Types Trigger Description
User Joins World A user successfully joins the world
User Waitlisted A user tries to join but the world is already at capacity
User Reported A user submits a Report about another user
 
To Add a World Webhook:
  1. Enter your Topia world
  2. In the left sidebar, click World Settings settings → Integrations
  3. In the Webhooks section, click Add Webhook
  4. Add:
    • Webhook Type: sets the trigger type. See table above for definitions.
    • Webhook Title: gives your webhook a name. This makes it easier for you to identify.
    • Webhook Description: explain what the webhook does. This field is optional.
    • Webhook URL: paste your webhook URL from the webhook service (e.g. Zapier) in this field.
    • Data Object Input: include a JSON object with this webhook payload. This JSON will be delivered with the webhook that fires and can be retrieved and saved through the API. This field is optional.
    • The Data Object Field is not editable. This is the data currently stored in the webhook and is filled automatically.
    • Limit webhook to trigger once per user per day: toggle on to limit to one trigger daily per user. This is optional.
  5. Click Add Webhook to save
  6. Topia will send data to this webhook when a user's activity matches the trigger

 

Asset Webhooks

You can also trigger webhooks to send alerts based on user interactions with assets. These are only triggered in specific locations in your world. 

Use Cases for Asset Webhooks

circleCheck

Get a real-time alert when someone needs assistance in your world

circleCheck

Track areas of your world to understand popularity and engagement

 

Asset Webhook Types Trigger Description Requirements
Asset Clicked A user clicks an asset Asset must be clickable
Broadcast Zone Entered A user enters a Broadcast Zone Asset must be a Broadcast Zone
Private Zone Entered A user enters a Private Zone Asset must be a Private Zone
Media Played A user approaches a media asset Asset must contain media (video or audio)
Media Play Finished A user walks away from a media asset
Webhook Zone Entered A user enters a Webhook Zone Asset must be a Webhook Zone
Webhook Zone Exited A user exits a Webhook Zone

 

To Add an Asset Webhook:
  1. Enter your Topia world
  2. Locate the asset that should trigger the webhook
  3. In the left sidebar, click Builder Mode builder  or press B on your keyboard to activate Builder Mode
  4. Click the edit edit icon on the trigger asset to open the Selection Menu
  5. Click the Configuration tab
  6. Option 1:
    • Select Integrations
    • In the Webhooks section, click the blue plus plus button
    Option 2:
    • Select Zones
    • Click the Zone Type dropdown menu and select Webhook Zone
    • In the Webhooks section, click the blue plus plus button
  7. In Create a webhook, add:
    • Webhook Type: sets the trigger type. See table above for definitions.
    • Webhook Title: gives your webhook a name. This makes it easier for you to identify.
    • Webhook Description: explain what the webhook does. This field is optional.
    • Webhook URL: paste your webhook URL from the webhook service (e.g. Zapier) in this field.
    • Data Object Input: include a JSON object with this webhook payload. This JSON will be delivered with the webhook that fires and can be retrieved and saved through the API. This field is optional.
    • The Data Object Field is not editable. This is the data currently stored in the webhook and is filled automatically.
    • Limit webhook to trigger once daily per user: toggle on to limit to one trigger per user per day. This is optional.
  8. Click Add Webhook to save
  9. Topia will send data to this webhook when a user's interaction with the asset matches the trigger