Skip to main content
Use the Boxpressd Sites SDK to display recent checkin activity for the venue associated with your API key. checkins are currently a venue-focused feature. If the resolved business context is not a venue, the SDK may return an empty list or report that checkins are unavailable for that business type.

Server Function

Use getBoxpressdCheckins when fetching checkins in server components, loaders, API routes, or other server-side code.

Function Signature

Options

React Hook

Use useCheckins when fetching checkins from client components.

Hook Signature

useCheckins is planned for the SDK and may not be available until a future release.

checkin Object

Username Fallback

The SDK normalizes user display names when checkin data is returned. The display name is resolved in this order:
This ensures public website components can show friendly activity even when a user profile has limited public information.

Example: Recent Activity Feed

Example: Paginated checkins

Internally, this SDK helper calls the Boxpressd API endpoint for the resolved venue:
For example:
Most SDK users should use getBoxpressdCheckins or useCheckins instead of calling the API directly.

Best Practices

  • Use checkins as social proof on venue websites.
  • Keep public activity feeds short and recent.
  • Avoid exposing sensitive user details.
  • Use the SDK’s normalized display name instead of manually building user names.
  • Gracefully hide the section when no checkins are available.

Next Steps

Continue to:
  • Sessions
  • Events
  • Components Overview
  • API Reference