OnSched API Utility

Name: OnSched API Utility API
Brand: OnSched API Utility
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsMonitoring Observabilityoauth22 EndpointsREST

For Agents

Confirm OnSched platform health with heartbeat and thread-info checks using OAuth 2.0 client-credentials authentication.

Connect the OnSched API Utility to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OnSched API Utility, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with OnSched API Utility API.

Run a heartbeat check to confirm the OnSched booking platform is reachable

Retrieve thread-info diagnostics for deeper troubleshooting of platform issues

Authenticate with OAuth 2.0 client credentials so utility checks share the same auth domain as Consumer and Setup

Drive an external status page with structured health responses

GET STARTED

Start building with OnSched API Utility API

Explore with Jentic

View OpenAPI Document

The OnSched Utility API is a small operational surface that sits alongside the OnSched Consumer and Setup APIs. It exposes platform health checks: a heartbeat endpoint that confirms the booking platform is reachable, and a thread information endpoint that returns runtime details for deeper diagnostics. It is the right surface for status pages, uptime monitors, and the synthetic checks that platform teams run against any OnSched-backed booking flow. Authentication uses the same OAuth 2.0 client credentials as the rest of the OnSched APIs.

Use Cases

Patterns agents use OnSched API Utility API for, with concrete tasks.

★ Synthetic health monitoring for booking flows

Platform teams running mission-critical booking flows on OnSched run a synthetic check every minute or so to confirm the platform is reachable. The heartbeat endpoint returns a structured signal that uptime monitors and on-call dashboards can ingest, and the thread-info endpoint adds a second level of detail when the heartbeat reports degraded performance. Most teams wire this up in under a day.

GET /utility/v1/health/heartbeat once a minute and alert when the response is non-200 or latency exceeds the SLO target.

Pre-flight check before triggering a booking workflow

When a downstream system is about to push a large batch of bookings or provisioning calls, a quick heartbeat check confirms the platform is healthy enough to accept the work. This avoids partial-success batches that need manual reconciliation. The Utility API is the lightest possible call to make for that gate, so it does not add meaningful latency to the workflow.

Before a nightly provisioning batch, GET /utility/v1/health/heartbeat and abort the batch if the response is degraded or non-200.

AI agent platform readiness through Jentic

An AI agent that orchestrates OnSched calls across many tenants can use the Utility API as a readiness gate. The agent searches Jentic for the heartbeat operation, executes it, and only proceeds with bookings or provisioning when the platform reports healthy. This stops the agent from issuing dozens of failing calls during an OnSched incident.

Search Jentic for 'onsched heartbeat', load the GET /utility/v1/health/heartbeat operation, and gate downstream booking actions on a healthy response.

Key Endpoints

2 endpoints — the onsched utility api is a small operational surface that sits alongside the onsched consumer and setup apis.

METHOD

PATH

DESCRIPTION

GET

/utility/v1/health/heartbeat

Check that the OnSched platform is reachable

GET

/utility/v1/health/threadinfo

Read thread-level diagnostic information

GET

/utility/v1/health/heartbeat

Check that the OnSched platform is reachable

GET

/utility/v1/health/threadinfo

Read thread-level diagnostic information

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Even though the Utility API is read-only, it shares the OAuth 2.0 client credentials with the Setup API, which is high-trust. Storing the credentials in the Jentic vault prevents accidental token reuse from a monitoring script into a higher-privilege context.

Intent-based discovery

Agents search Jentic with intents like 'onsched heartbeat' or 'check booking platform health' and Jentic returns the two Utility operations with their input schemas, so the readiness check is one Jentic call away.

Time to first call

Direct OnSched Utility integration: a few hours to wire up OAuth and the heartbeat poll. Through Jentic: under 30 minutes because the OAuth handling and schema are pre-loaded.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

OnSched Consumer API

End-user booking surface that the Utility API monitors the health of

Use the Consumer API alongside the Utility API when the agent runs end-user bookings and wants a readiness gate before issuing calls.

Complementary

OnSched Setup API

Configuration surface that benefits from a Utility heartbeat before bulk provisioning

Use the Setup API alongside the Utility API when the agent is about to run a provisioning batch and wants to confirm the platform is healthy first.

Alternative

Calendly API

Hosted scheduling product, monitored via its own status page rather than a heartbeat endpoint

Choose Calendly when the team has not adopted OnSched and instead relies on the Calendly hosted product, where monitoring is handled by Calendly's status feed.

FAQs

Specific to using OnSched API Utility API through Jentic.

What authentication does the OnSched Utility API use?

The Utility API uses OAuth 2.0 client credentials, the same scheme as the OnSched Consumer and Setup APIs. Through Jentic, the credentials are stored in the vault and the access token is refreshed transparently, so monitoring agents do not need to manage the secret themselves.

What does the heartbeat endpoint return?

GET /utility/v1/health/heartbeat returns a structured response indicating whether the OnSched platform is reachable. It is the lightest possible call to confirm the booking surface is up, and it is the right thing to plot on a status page or run from an uptime monitor.

What is the difference between heartbeat and thread-info?

Heartbeat is a binary up-or-degraded signal designed to be polled frequently. GET /utility/v1/health/threadinfo returns runtime details that are useful for diagnostic tickets and post-incident reviews, but it is not designed to be polled at high frequency. Treat thread-info as on-demand and heartbeat as periodic.

What are the rate limits for the OnSched Utility API?

OnSched does not publish a global rate limit in the spec. The Utility surface is intentionally tiny (2 endpoints) and is sized for periodic polling rather than high-frequency reads. A heartbeat poll every 30 to 60 seconds per environment is well within reasonable usage.

How do I gate a booking workflow on platform health through Jentic?

Install the SDK with 'pip install jentic', search for the operation with the query 'onsched heartbeat', then load the GET /utility/v1/health/heartbeat operation, and execute it before kicking off the workflow. If the response is healthy, proceed with the Consumer or Setup API calls; otherwise short-circuit and alert.