New Worklix brings monitoring, time tracking and collaboration into one workforce platform.

Using ping requests via API

The Ping endpoint is a lightweight way to verify that your integration can reach Worklix and authenticate successfully.

Keep API credentials server-side.

Do not expose production tokens in browser code, public repositories or shared client-side configuration.

Request

Send a GET request with your API token. A healthy request returns a small JSON payload and a request identifier.

GET https://api.worklix.com/v1/ping
Authorization: Bearer wl_live_your_token_here

Example response

A successful response confirms the API is reachable and the token was accepted.

{
  "data": {
    "status": "ok",
    "workspace_id": "ws_92a1",
    "timestamp": "2026-09-15T00:10:00Z"
  }
}

When to use it

Use ping during deployment checks, scheduled integration health tests or before long-running jobs. Do not use it as a high-frequency heartbeat when normal request monitoring already provides the same signal.

Was this article helpful?

Build with clearer API context

Know the resource first.Then build the connection.

Use the Worklix API guides to plan authentication, data flow and production ownership before your integration reaches live workforce data.

Start With the API Contact Worklix