Workhuman Ci Integration

Overview

Guidance for ci integration with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Common Errors

Overview

Guidance for common errors with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Core Workflow A

Overview

Guidance for core workflow a with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Core Workflow B

Overview

Guidance for core workflow b with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Cost Tuning

Overview

Guidance for cost tuning with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Debug Bundle

Overview

Guidance for debug bundle with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Deploy Integration

Overview

Guidance for deploy integration with Workhuman Social Recognition and rewards API.

Instructions

Key Workhuman API Concepts

• Auth: OAuth 2.0 client credentials flow
• Recognition: Peer-to-peer and manager nominations with points
• Awards: Configurable levels (bronze, silver, gold, platinum)
• Values: Company values attached to recognitions
• HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
• Integrations: Microsoft Teams, Slack, Outlook native plugins

Core API Endpoints

Error Handling

Resources

• Workhuman Platform
• Workhuman Integrations

Next Steps

See related Workhuman skills for more patterns.

Workhuman Hello World

Overview

Create a recognition nomination and list recent recognitions -- the two fundamental Workhuman API operations. Workhuman Social Recognition enables peer-to-peer and manager-to-employee recognition with points-based rewards.

Instructions

Step 1: List Recent Recognitions

const { data: recognitions } = await api.get('/api/v1/recognitions', {
  params: { limit: 10, sort: '-created_at' },
});

recognitions.data.forEach((rec: any) => {
  console.log(`${rec.nominator.name} recognized ${rec.recipient.name}`);
  console.log(`  Award: ${rec.award_level} | Points: ${rec.points}`);
  console.log(`  Message: ${rec.message}`);
  console.log(`  Value: ${rec.company_value}`);
});

Step 2: Create a Recognition Nomination

const nomination = await api.post('/api/v1/recognitions', {
  recipient_id: 'emp-12345',
  award_level: 'silver',
  company_value: 'innovation',
  message: 'Outstanding work on the Q1 product launch. Your innovative approach to the deployment pipeline saved the team 3 days of work.',
  points: 500,
  visibility: 'public',  // 'public', 'team', 'private'
});

console.log(`Recognition created: ${nomination.data.id}`);
console.log(`Status: ${nomination.data.status}`); // pending_approval or approved

Step 3: Check Recognition Status

const { data: status } = await api.get(`/api/v1/recognitions/${nomination.data.id}`);
console.log(`Status: ${status.status}`);
// Status: pending_approval -> approved -> delivered

Step 4: List Reward Catalog

const { data: catalog } = await api.get('/api/v1/rewards/catalog', {
  params: { category: 'gift_cards', country: 'US' },
});

catalog.items.forEach((item: any) => {
  console.log(`${item.name} - ${item.points_required} points`);
});

Output

Jane Smith recognized Alex Johnson
  Award: Silver | Points: 500
  Message: Outstanding work on the Q1 product launch...
  Value: Innovation
Recognition created: rec-67890
Status: pending_approval

Error Handling

Resources

• Workhuman Social Recognition
• workhuman-install-auth SKILL.md View full skill →

  'Workhuman install auth for employee recognition and rewards API.

  ReadWriteEditBash(npm:*)Grep

  Workhuman Install & Auth

  Overview

  Configure Workhuman API access for Social Recognition, rewards, and HRIS integration. Workhuman uses OAuth 2.0 for API authentication. The API enables programmatic recognition nominations, reward redemption, and employee data sync.

  Prerequisites

  • Workhuman enterprise account with API access enabled
  • OAuth client credentials from Workhuman admin portal
  • HTTPS endpoint for redirect URI (if using auth code flow)

  Instructions

  Step 1: Configure OAuth Credentials

  
  # .env
  WORKHUMAN_CLIENT_ID=your-client-id
  WORKHUMAN_CLIENT_SECRET=your-client-secret
  WORKHUMAN_BASE_URL=https://api.workhuman.com
  WORKHUMAN_TENANT_ID=your-tenant-id
  

  Step 2: Obtain Access Token (Client Credentials)

  
  import axios from 'axios';
  
  async function getWorkhmanToken(): Promise<string> {
    const { data } = await axios.post(
      `${process.env.WORKHUMAN_BASE_URL}/oauth/token`,
      new URLSearchParams({
        grant_type: 'client_credentials',
        client_id: process.env.WORKHUMAN_CLIENT_ID!,
        client_secret: process.env.WORKHUMAN_CLIENT_SECRET!,
      }),
      { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } },
    );
    return data.access_token;
  }
  

  Step 3: Verify Connection

  
  const token = await getWorkhmanToken();
  const api = axios.create({
    baseURL: process.env.WORKHUMAN_BASE_URL,
    headers: { Authorization: `Bearer ${token}` },
  });
  
  const { data } = await api.get('/api/v1/users/me');
  console.log(`Connected as: ${data.displayName}`);
  

  Step 4: Python Client

  
  import requests, os
  
  class WorkhumanClient:
      def __init__(self):
          self.base = os.environ["WORKHUMAN_BASE_URL"]
          self.token = self._authenticate()
  
      def _authenticate(self):
          resp = requests.post(f"{self.base}/oauth/token", data={
              "grant_type": "client_credentials",
              "client_id": os.environ["WORKHUMAN_CLIENT_ID"],
              "client_secret": os.environ["WORKHUMAN_CLIENT_SECRET"],
          })
          return resp.json()["access_token"]
  
      def get(self, endpoint, **params):
          return requests.get(f"{self.base}{endpoint}",
              headers={"Authorization": f"Bearer {self.token}"}, params=params).json()
  

  Error Handling

  workhuman-local-dev-loop SKILL.md View full skill →

  'Workhuman local dev loop for employee recognition and rewards API.

  ReadWriteEditBash(npm:*)Grep

  Workhuman Local Dev Loop

  Overview

  Guidance for local dev loop with Workhuman Social Recognition and rewards API.

  Instructions

  Key Workhuman API Concepts

  • Auth: OAuth 2.0 client credentials flow
  • Recognition: Peer-to-peer and manager nominations with points
  • Awards: Configurable levels (bronze, silver, gold, platinum)
  • Values: Company values attached to recognitions
  • HRIS Sync: Bidirectional sync with Workday, SAP SuccessFactors
  • Integrations: Microsoft Teams, Slack, Outlook native plugins

  Core API Endpoints

  Error	Cause	Solution
  401 Unauthorized	Invalid credentials	Check client_id/secret
  403 Forbidden	Insufficient permissions	Contact Workhuman admin
  invalid_grant

  Endpoint	Method	Description
  /api/v1/recognitions	GET	List recognitions
  /api/v1/recognitions	POST	Create nomination
  /api/v1/recognitions/:id	GET	Get recognition status
  /api/v1/users	GET	List employees
  /api/v1/rewards/catalog	GET	Browse reward catalog
  /api/v1/rewards/redeem	POST	Redeem points for reward

  Error Handling

  Error	Cause	Solution
  401 Unauthorized	Token expired	Re-authenticate
  403 Forbidden	Insufficient permissions	Check role/permissions
  422 Validation	Missing fields	Check required fields
  404 Not Found	Invalid ID	Verify resource exists

  Resources

  • Workhuman Platform
  • Workhuman Integrations

  Next Steps

  See related Workhuman skills for more patterns.