> ## Documentation Index
> Fetch the complete documentation index at: https://docs.serval.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paycom

> Connect Serval to Paycom, the HR and payroll platform, so your workflows can read employee data, manage time and attendance punches, and work with applicants, new hires, positions, and labor allocation.

## About Paycom

Paycom is an HR and payroll platform that holds your organization's employee, time and attendance, applicant, and labor allocation data. Serval connects to a single Paycom client account using the REST API credentials Paycom issues to your organization. Once connected, your Serval workflows can read HR data and import or edit time card punches whenever they run. Serval only ever sends your credential to one host for this integration: api.paycomonline.net.

**Authentication:** Paycom REST API credentials — a SID (your client security identifier) and a token, stored together as one credential and sent as HTTP Basic auth. There is no OAuth flow.

**Data sync:** On-demand only. Workflows call the Paycom API at the moment they run. There is no background sync, no data ingestion, no webhooks, and no event triggers.

<Warning>
  Paycom only accepts API requests from IP addresses that are allowlisted for your client account. Before connecting, ask your Paycom specialist to allowlist the addresses Serval calls Paycom from — contact [support@serval.com](mailto:support@serval.com) for the current list of Serval egress IPs. If your organization cannot allowlist Serval's IPs, the connection can instead be routed through a Serval self-hosted worker running inside a network whose egress IP Paycom already trusts; contact [support@serval.com](mailto:support@serval.com) to set this up.
</Warning>

## What the Paycom integration enables

| Capability                  | Description                                                                                                                                                                                                                     |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Employee data               | Read the employee directory, full employee master records, and (where your credential permits) sensitive data such as pay rates, tax setup, and deposit distributions. Look up employees by their four-character employee code. |
| Employee changes            | List employees whose records changed in a time window and read the specific changes, including custom-field and sensitive-data change histories — useful for building sync workflows.                                           |
| Time and attendance         | Import punches, hours, or earnings to employee time cards in real time; edit or delete existing punches; read punch history, punch audit trails, and live clocked-in/out status.                                                |
| Applicants and new hires    | Read applicant tracking (ATS) data — applications, statuses, workflow steps — and new hire records, photos, and custom fields.                                                                                                  |
| Positions                   | Read position details, levels, and seats from Position Management.                                                                                                                                                              |
| Labor allocation            | Read and manage labor allocation profiles, categories, and distribution details, including bulk additions.                                                                                                                      |
| Company setup               | Read company establishments, locations, and earning codes.                                                                                                                                                                      |
| Full Paycom REST API access | Workflows are not limited to the capabilities above — they can reach any Paycom REST API endpoint your credential is permitted to use.                                                                                          |

Anything in the Paycom REST API can be accessed through Serval.

## Get your credentials

Paycom issues REST API credentials per client. There is no self-service developer portal — credentials are provisioned by Paycom for your account.

<Steps>
  <Step title="Request API access from Paycom">
    Ask your Paycom dedicated specialist or client representative to enable the REST API for your client account and to create an API service user. They will issue you a SID (client security identifier) and a token.
  </Step>

  <Step title="Allowlist Serval's IP addresses">
    Ask your Paycom specialist to allowlist the IP addresses Serval will call Paycom from. Contact [support@serval.com](mailto:support@serval.com) to get the current list of Serval egress IPs.

    <Warning>
      Requests from IPs that are not allowlisted fail to authenticate even with valid credentials. If you cannot allowlist Serval's IPs, contact [support@serval.com](mailto:support@serval.com) about routing this connection through a self-hosted worker instead.
    </Warning>
  </Step>

  <Step title="Connect in Serval">
    In Serval, add the Paycom integration and enter your SID and token. Serval encodes them as HTTP Basic auth automatically — you do not need to base64-encode anything yourself.
  </Step>
</Steps>

## Rate limits

Paycom enforces per-endpoint rate limits (calls per second and calls per day); each endpoint's limits are documented on its operation in the Serval workflow builder. Most read endpoints allow 10 calls per second; punch-import writes allow 3 calls per second. List endpoints paginate with `page` (starting at 1) and `pagesize` (default 25, maximum 500) parameters.

## Security notes

* Your SID and token are stored encrypted and injected into requests server-side. Workflow authors and workflow code never see the credential.
* Serval only injects the credential toward api.paycomonline.net.
* Read access to sensitive employee data (pay rates, tax details, deposit accounts, SSNs) is controlled by the permissions Paycom grants your API service user — scope it to only what your workflows need.