Skip to main content
essentry provides real-time notifications about changes to objects in your system, allowing you to stay informed about activity as it happens. Real-time notifications inform your system when objects are created, updated, or transitioned between states. This keeps your system synchronized with essentry and enables immediate responses to visitor activity.

​
Delivery Methods

essentry offers two methods for receiving real-time notifications:

​
Webhooks

HTTP-based callbacks sent to your system when objects change. We recommend webhooks if your target system is reachable from the cloud, as they provide reliable delivery and automatic retries. Benefits:
  • Automatic retries ensuring reliable delivery
  • Simple HTTP-based implementation
  • Dashboard configuration (when available)
Requirements:
  • Your system must be reachable from the internet
  • HTTPS endpoint to receive webhook calls
Webhook configuration is currently a beta feature that may not be available in your account yet. Please contact our support team at support@essentry.com to configure webhooks or request access to the dashboard feature.

​
WebSockets

Persistent connections that provide real-time notifications when objects change. WebSockets work well for systems behind NAT without public IP addresses, as your system initiates the outbound connection to essentry. Benefits:
  • Works behind NAT (no public IP required)
  • Real-time bidirectional communication
  • No inbound firewall configuration required
Requirements:
  • Your system must allow outbound HTTPS/WebSocket connections
  • More implementation work on the client side
  • Connection management and reconnection logic
  • WebSocket client implementation
Connection Details:
  • URL: wss://app.essentry.com/api/v2/ws
  • Authentication: Required - see Authentication for details on authenticating your WebSocket connection.
Implementation examples for WebSocket integration will be provided by our support team at support@essentry.com based on your specific requirements.

​
Payload Types

Real-time notifications can be configured for different types of objects. Both payload types provide the same data structure regardless of whether they’re delivered via webhooks or WebSockets, ensuring consistent integration regardless of your chosen delivery method.

​
Check-Ins

Notifications sent whenever check-ins are created, updated, or transitioned between states. This includes:
  • New visitor check-ins completed at kiosks
  • Check-in approvals by receptionists
  • Visitor check-outs
  • State changes (pending, approved, rejected, etc.)
The payload contains complete check-in information including visitor details, current state, legitimation data, and the result of the identity verification.
​
checkIn
object
required
The check-in object containing all visitor and visit information

​
Access Credentials

Notifications sent whenever access credentials are created, updated, or changed. This includes:
  • Card number or credential type updates
  • Assignment changes (including when cards are unassigned)
This enables your access control system to stay synchronized with essentry’s credential management.
​
accessCredential
object
required
The access credential object containing card and assignment information