Calven
Calven
  • Overview
  • Authenticating
  • SDKs
  • Authentication
    • Generate a token with an API key and HMAC
      POST
    • Generate a token with an API key and client secret
      POST
  • Events
    • Events Api
    • Submit presence events with BASIC auth
      POST
    • Submit presence events
      POST
    • Submit occupancy events
      POST
  • Time off
    • Submit time off updates
      POST
  • Access-credential
    • Submit access credentials
      POST

SDKs

Node.js SDK#

A Calven API SDK is available for node.js via NPM - https://www.npmjs.com/package/@calven-code/calvenapi

Installation#

Usage#

The library provides clients for the following Calven API services:
Occupancy events
Presence events
Timeoff notification events
The library exposes the CalvenAPI class, which provides static factory methods for creating clients for the above services.
Each method accepts an API Key and an API key secret. You can optionally provide the base URL for the Calven API. If you do not provide a base URL, the client will use the default Calven API URL.

Occupancy client#

Presence client#

Timeoff client#

Endpoint and region selection#

The Calven API is available in multiple regions. You can specify the region to use by passing an optional CalvenClientConfig when creating a client. If you do not specify a region, the client will use the default region, which is the US.
For example, to select the Australian region:
You can also pass a baseUrl in the CalvenClientConfig to specify a custom Calven API URL. The default value is the production Calven endpoint.
Modified at 2023-12-20 21:46:35
Previous
Authenticating
Next
Generate a token with an API key and HMAC
Built with