Articles in this section

How Connect Works

Connect brings together Butlr’s data access and sharing features in one place.

Use Connect when you want Butlr data to leave the dashboard, whether through API access, real-time webhooks, email alerts, or shareable live occupancy views.

Connect currently includes:

FeatureWhat it is used for
API TokensGenerate credentials for accessing Butlr APIs
WebhooksSend Butlr events to an external system in real time
Email AlertsSend occupancy threshold alerts by email
Public URLsShare a live occupancy view without requiring a Butlr login

 


 

1. API Tokens

API tokens allow your organization to access Butlr data through the Butlr API.

Use API tokens when your team wants to connect Butlr data to an internal dashboard, reporting workflow, data warehouse, or third-party system.

How to view API tokens

  1. Go to Connect
  2. Open API Tokens
  3. Review the available tokens for your organization

Each token may include details such as:

  • Token name
  • Client ID
  • Created date
  • Status

Notes

  • API tokens should only be shared with trusted technical teams.
  • If a token is no longer needed, it should be removed or rotated.
  • API tokens are organization-level credentials, so treat them like passwords.

 


 

2. Webhooks

Webhooks allow Butlr to send events to an external system in real time.

Use webhooks when your team wants another system to automatically receive Butlr events, such as occupancy events, traffic events, or other supported event types.

How to create a webhook

  1. Go to Connect
  2. Open Webhooks
  3. Click Create Webhook
  4. Enter the destination URL
  5. Select the event types you want to send
  6. Add authentication headers if required
  7. Save the webhook

Authentication headers

Authentication headers are optional security details that help the receiving system verify that the webhook is coming from Butlr.

For example, your IT or integration team may provide a header name and value that need to be included with each webhook request.

Notes

  • The destination URL must be provided by the system receiving the webhook.
  • If authentication is required, confirm the correct headers with your technical team.
  • Webhooks are best for real-time event delivery, not historical reporting.

 


 

3. Email Alerts

Email alerts allow users to receive notifications when occupancy crosses a configured threshold.

Use email alerts when a team needs to be notified about space usage without logging into the dashboard.

Example use cases:

  • A restroom has exceeded a cleaning threshold
  • A room or space is above a configured occupancy level
  • A facilities team wants simple email-based notifications

How to create an email alert

  1. Go to Connect
  2. Open Email Alerts
  3. Click Create Alert
  4. Select the space you want to monitor
  5. Set the occupancy threshold
  6. Add the email recipients
  7. Save the alert

Notes

  • Email alerts are based on the selected space and threshold.
  • Recipients do not necessarily need to use the dashboard to receive alerts.
  • Email alerts are useful for operational workflows where teams need a simple notification.

 


 

4. Public URLs

Public URLs allow you to share a live occupancy view without requiring viewers to log into Butlr.

Use public URLs for shared screens, kiosks, lobby displays, or space availability views.

Example use cases:

  • Showing live restroom availability
  • Displaying floor-level occupancy on a shared screen
  • Helping employees or visitors find available spaces
  • Showing lab, bench, or room availability in a controlled display area

How to create a public URL

  1. Go to Connect
  2. Open Public URLs
  3. Click Create Public URL
  4. Select the space or view you want to share
  5. Configure the display settings
  6. Save and copy the URL

Notes

  • Anyone with the URL may be able to view the shared page.
  • Public URLs should only be used for views that are safe to share broadly.
  • Do not use public URLs for sensitive or user-specific information.

 

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.