Onsched Utility
Onsched Utility is an API tool for working with OnSched appointment scheduling and booking services.
- Base URL:
https://sandbox-api.onsched.com - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
https://sandbox-identity.onsched.com/connect/tokenusing yourclientId/clientSecret, then calls the API.
Operations
get_utility_v1_health_heartbeat— GET /utility/v1/health/heartbeatget_utility_v1_health_threadinfo— GET /utility/v1/health/threadinfo
Inputs
clientId/clientSecret— your onsched-utility OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_utility_v1_health_heartbeat
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for onsched-utility. |
clientSecret |
string | yes | — | OAuth client secret for onsched-utility. |
operation |
string | yes | — | One of: get_utility_v1_health_heartbeat, get_utility_v1_health_threadinfo |
scope |
string | no | OnSchedApi distance |
OAuth scopes (space-separated); default from the spec. |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |