Get Partner Profile

This action simulates a Wellness Partner retrieving and managing their profile information from Workday's system. This step ensures that all partner details are current and accurate.

What it does:

• Retrieves Profile: Fetches the complete partner profile using the unique Partner Client ID
• Create and Update Profile: Corresponding actions are avaialble to Wellness Partners (not shown in this simulation) allowing partners to create and modify their contact details, business information, and capabilities.

Example Create Profile Request:

              {
  "name": "Willowgate Insurance Group",
  "description": "Welcome to Willowgate Insurance Group",
  "websiteURL": "https://workdaysolutiondemo.com",
  "logoURL": "https://workdaysolutiondemo.com/wellness/img/logos/willowgate.png",
  "callbackURL": "https://workdaysolutiondemo.com/wellness/partner/webhook_receiver.php",
  "taxIdentificationNumber": "987654321",
  "useCases": [
    {
      "useCaseType": "WORKER_DATA_AND_ENROLLMENT",
      "useCaseTypeStatus": "ENABLED"
    },
    {
      "useCaseType": "EVIDENCE_OF_INSURABILITY",
      "useCaseTypeStatus": "ENABLED"
    },
    {
      "useCaseType": "CONNECTED_ABSENCE",
      "useCaseTypeStatus": "ENABLED"
    },
    {
      "useCaseType": "BENEFIT_PLAN_SETUP_AUTOMATION",
      "useCaseTypeStatus": "ENABLED"
    },
    {
      "useCaseType": "WORKER_COMMUNICATION_CARDS",
      "useCaseTypeStatus": "ENABLED"
    }
  ]
}
              

Expected Response:

The response will be a JSON object containing:

• Partner identification and contact information
• Business details including Name, Description, Logo, URL, callback URL
• Available services and supported use cases

Note: This information forms the foundation for all subsequent partner interactions and should be kept up-to-date to ensure smooth integration workflows.

Create Company Access

This action simulates the critical process of establishing a connection between a Wellness Partner and a company's Workday tenant. This is the "friend request" that enables all subsequent data exchanges and service integrations.

The Workflow:

• Access Code Sharing: The customer securely shares the Access Code from their Workday tenant with the Wellness Partner
• Access Request: The Wellness Partner uses this Access Code to create a formal company access request
• Partner Submission: The Wellness Partner submits their credentials and service capabilities to the customer
• Customer Review: The customer reviews the partner's information and makes a decision to approve or deny the request

How to Obtain the Access Code:

• Navigate to Manage Wellness Partners in your Workday tenant
• Select Company Profile > Get Access Code
• Copy the generated Access Code
• Paste it into the Access Code field within Settings

Required Information:

• Access Code: The unique code provided by the customer's Workday administrator

Expected Response:

The response will be a JSON object sent to the callback URL defined by the Wellness Partner. For demonstration purposes, "access responses" for all Wellness Partners are captured in the Response Dashboard.

• The Tenant ID
• Tenant Name
• Customer Decision
• Use Cases Approved
• Decider Name

The callback URL is defined by the Wellness Partner in the Create Profile Request. We manually copy the tenantId from the response dashboard because it is asynchronous.

Create Benefit Plan

This action simulates a Wellness Partner submitting benefit plan for a company. This is where the partner defines the specific wellness services, eligibility criteria, and integration parameters that will govern the employee wellness program.

What it does:

• Plan Configuration: Sets up the foundational structure for the wellness benefit offering
• Service Definition: Specifies which wellness services will be available to employees

Use Case Restrictions:

The available functionality depends on your Workday tenant's allowed use case configuration:

Required Information:

• Company Access Token: Valid authentication from the Create Company Access step
• Plan Details: Name, description, effective dates, and eligibility criteria
• Service Configuration: Specific wellness services and their parameters
• Use Case Selection: Chosen use cases (within allowed restrictions)

Expected Response:

The response will be a JSON object containing:

• Benefit plan creation confirmation and unique ID's

Worker Data

This action simulates a Wellness Partner retrieving employee (worker) data from a company's Workday tenant. This is the core data exchange that enables personalized wellness services, eligibility verification, and targeted program delivery to employees.

What it does:

• Data Retrieval: Securely fetches employee information
• Real-time Sync: Provides current employee information including recent changes

Data Categories Available:

Required Information:

• Data Scope: Specify which data categories are needed for your wellness services
• Filtering Criteria: Define whether to include dependents, beneficiaries, other party information or other filters (optional)
• Update Preferences: How frequently you want to receive data updates

Expected Response:

The response will be a JSON object containing:

• Array of eligible employee records with requested data fields
• Data retrieval metadata (timestamp, record count, filtering applied)
• Integration status and any data quality warnings

Error in Worker Data

This action simulates a Wellness Partner identifying and reporting data quality issues or discrepancies in worker information back to the company's Workday tenant. This critical feedback loop ensures data accuracy and helps maintain the integrity of the wellness program.

What it does:

• Error Detection: Identifies inconsistencies, missing data, or invalid information in worker records
• Issue Reporting: Communicates specific data problems back to the company's tenant
• Resolution Tracking: Provides a mechanism to track error correction progress
• Data Quality Improvement: Helps maintain high-quality employee data for better service delivery

Common Error Types:

Required Information:

• Employee Identifier: Unique ID or identifier for the affected worker
• Error Type: Classification of the data issue (validation, business rule, etc.)
• Error Description: Detailed explanation of what's wrong with the data
• Expected Value: What the correct data should be (if known)
• Current Value: The problematic data that was received
• Severity Level: How critical the error is to wellness service delivery

Error Reporting Process:

1. Detection: Partner systems identify data anomalies during processing
2. Validation: Confirm the error isn't due to partner system issues
3. Documentation: Gather all relevant details about the data problem
4. Submission: Send error report to company's Workday system
5. Follow-up: Track resolution and verify corrected data

Expected Response:

The response will be a JSON object containing:

• Error report confirmation with unique tracking ID
• Acknowledgment timestamp and processing status
• Assigned priority level and estimated resolution timeframe
• Company contact information for error resolution follow-up
• Next steps in the error correction workflow

Absence Individual Card Category

This action simulates a Wellness Partner creating an absence individual card category in Workday. This establishes a template or category structure that defines how absence-related communication cards will be displayed to workers. This is the first step in the card creation workflow.

What it does:

• Category Definition: Creates a reusable card category template that defines the structure, appearance, and behavior of absence-related cards
• Template Configuration: Sets up the visual elements, messaging, and interaction options for cards in this category
• Display Settings: Configures where and how these cards will appear in the Workday interface

Required Information:

• Tenant ID: The unique identifier obtained from the Create Company Access response
• Partner Name (Client Name): The unique Wellness Partner identifier

Card Category Configuration:

The card category includes the following configurable elements:

Expected Response:

The response will be a JSON object containing:

• Card category creation confirmation
• Unique card category ID for use in subsequent individual card creation
• Validation status and any configuration warnings

Note: The card category ID returned from this action is required when creating individual cards for specific workers in the next step.

Individual Card

This action simulates a Wellness Partner creating an individual communication card for a specific worker. This is the second step in the card creation workflow, where personalized cards are generated based on the card category template created in the previous step.

What it does:

• Personalized Card Creation: Generates a customized communication card for a specific employee based on their profile and preferences
• Worker-Specific Content: Associates the card with a particular worker and includes personalized messaging and information
• Card Delivery: Makes the card available to the worker in their Workday interface based on the display settings configured in the card category

Required Information:

• Tenant ID: The unique identifier obtained from the Create Company Access response
• Large Value String: The primary message or headline text displayed prominently on the card (e.g., "Prioritize Your Wellbeing")
• Card Category Reference: The card category ID from the Absence Individual Card Category step
• Worker ID: The unique identifier for the specific worker who will receive the card

Card Configuration Elements:

Workflow:

1. Category Creation: First, create an Absence Individual Card Category to establish the template
2. Worker Identification: Identify the specific worker who should receive the card (typically from Worker Data retrieval)
3. Card Personalization: Create the individual card with worker-specific content and messaging
4. Card Delivery: The card becomes available to the worker in their Workday interface

Expected Response:

The response will be a JSON object containing:

• Individual card creation confirmation
• Unique card ID for tracking and management
• Worker association confirmation
• Card delivery status and availability information

ID Flow

General flow of the ID's flowing between the Wellness Partner Simulation and the demo tenant.