Workday Benefits Benefit Events API
Manage benefit qualifying events and open enrollment
Workday Benefits Benefit Events API is one of 6 APIs that Workday Benefits publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 14 JSON Schema definitions.
Tagged areas include Benefit Events. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a changelog, a support channel, and 14 JSON Schemas.
This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version v40.2.
Requests are made against a single base URL, https://{tenant}.workday.com/api/benefits/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Workday Benefits Benefit Events API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope.
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Manage benefit qualifying events and open enrollment
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BenefitEvent (7 properties), ErrorResponse (3 properties), BenefitEventsResponse (2 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 Workday Benefits 5
Other APIs Workday Benefits publishes across the network.