WakaTime Heartbeats API
Coding-activity pings sent by editor plugins.
WakaTime Heartbeats API is one of 20 APIs that WakaTime publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Heartbeats. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a changelog, a status page, and 4 JSON Schemas.
This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version v1.
Requests are made against 2 base URLs: https://wakatime.com/api/v1, https://api.wakatime.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
WakaTime Heartbeats API declares
3 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode and implicit flows, exposing 8 scopes.
It accepts HTTP basic authentication (apiKey).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
oauth2— OAuth 2.0 authorization code flow.apiKey— HTTP Basic with the WakaTime API key as the username. Alternatively, pass ?apikey=... as a query parameter.bearerAuth— OAuth access token in the Authorization header as Bearer wakatok....
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Coding-activity pings sent by editor plugins.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is HeartbeatInput (15 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WakaTime 12
Other APIs WakaTime publishes across the network.