PrimePay Integration

Payroll, tax, and HR payment services for employers. Connect PrimePay employee events to workflows that provision tools, notify managers, and update records. Start with Watch Activity Code, then use Create an Activity Code or Get an Employer Document for the next step.

Explore Documentation

3-day trialCancel anytimeUp to 10 minutes quick set up

GDPR
Data Encryption
2FA
Local Data Region

Supported triggers and actions for PrimePay integration

Triggers can detect changes in PrimePay and run actions that can create, search or modify data inside PrimePay automatically [3] — exactly how you set them.

Watch Activity CodeTriggers when an activity code is updated or added.
Watch Benefit PlanTriggers when a new benefit plan is added or updated.
Watch Benefit Plan DataTriggers when benefit plan data is updated or created.
Watch Benefit Rate Adjustment AmountTriggers when there is a benefit rate adjustment amount.
Watch Benefit Rate AdjustmentsTriggers when a benefit rate adjustment is made.
Watch Budget PositionsTriggers when there is a change in budget positions within the organization.
Watch Deduction ClassesTriggers when a new deduction class is created.
Watch Dependent DataTriggers when there is new dependent data available.
Watch Dependent EnvironmentTriggers when there is a change in the dependent environment.
Watch Direct DepositsTriggers when a new direct deposit is made.
Watch Financial Plan ElectionTriggers when a financial plan election is made.
Watch Garnishment PayeesTriggers when there are new or updated garnishment payees.
Watch JobsTriggers when a new job is posted.
Watch LocationTriggers when a location is updated or detected.
Watch Location Scoped AdministrationTriggers when there's a change in location scope administration.
Watch Managing PositionTriggers when there is a change in a managing position.
Watch Marital StatusTriggers when a marital status is updated.
Watch OrganizationTriggers when there are changes in the organization structure or details.
Watch Organization Scoped AdministrationTriggers when there are changes in organization scoped administration settings.
Watch Pay ProcessTriggers when a pay process is initiated or changed.
Watch Pay Unit EDT RelationshipTriggers when there is a change in the pay unit EDT relationship.
Watch Pay Unit PeriodsTriggers when a pay unit period is observed.
Watch Pay Unit Scoped AdministrationTriggers when there is a change in the pay unit scope administration.
Watch PaymentsTriggers when a new payment is made by a person.
Watch Person AddressTriggers when a person's address is updated or added.
Watch Person Benefit ElectionTriggers when a person's benefit election is created or updated.
Watch Person Benefit PlanTriggers when there is a change in a person benefit plan.
Watch Person CompensationTriggers when a change in person compensation occurs.
Watch Person Compensation TotalTriggers when a change occurs in the total compensation for a person.
Watch Person DataTriggers when new person data is available.
Watch Person Disability StatusTriggers when a person's disability status changes.
Watch Person EmailTriggers when a new email is sent or received for a specific person.
Watch Person EmploymentTriggers when a person's employment status changes.
Watch Person LocationTriggers when a person's location is monitored.
Watch Person Misc DeductionTriggers when there is a change in a person's miscellaneous deduction.
Watch Person NameTriggers when a person name is updated or added in the system.
Watch Person PayrollTriggers when a person's payroll is updated or created.
Watch Person PositionTriggers when a person's position is updated or changed.
Watch Person Tax ElectionTriggers when a person tax election is made or updated.
Watch Person TimeTriggers when a person's time entry is recorded or updated.
Watch Person Veteran StatusTriggers when there is a change in a person's veteran status.
Watch Person VitalsTriggers when a person's vital signs are updated.
Watch Phone NumbersTriggers when a person's phone number is updated or added.
Watch PositionTriggers when a new position is created or updated.
Watch Position Comp PlanTriggers when there is a change in a position compensation plan.
Watch Position Comp Plan TagTriggers when a new position compensation plan tag is created or updated.
Watch Position LocationTriggers when a new position location is detected.
Watch Position Matrix OrganizationTriggers when there is a change in the position matrix organization.
Watch Position OrganizationTriggers when there is a change in position organization.
Watch Position Plan CompensationTriggers when there is a change in position plan compensation.
Watch Position StructureTriggers when a position structure is updated or changed.
Watch Salary Grade RegionTriggers when a salary grade region is updated or changed.
Watch Salary GradesTriggers when new salary grades are created or existing ones are updated.
Watch Salary GradesTriggers when there are changes in salary grade ranges.
Watch Target EarningsTriggers when target earnings are updated or reached.
Watch Welcome EmailsTriggers when a welcome email is sent or received.
Watch Worker's Compensation PlanTriggers when there is an update to the worker's compensation plan.
Watch Workers' Compensation RatesTriggers when a workers' compensation rate is updated.
Create an Activity CodeCreates a new activity code.
Get an Employer DocumentRetrieves a specified document related to an employer.
List Activity CodesRetrieves a list of activity codes.
List AddressesRetrieves a list of addresses for a person.
List Benefit ElectionsRetrieves a list of benefit elections for a person.
List Benefit PlansRetrieves a list of benefit plans for a company and their basic information.
List Benefit Program DataRetrieves a list of compensation plans for a company and their basic information.
List Benefit Rate Adjustment AmountsRetrieves a list of benefit rate adjustment amounts.
List Benefit Rate AdjustmentsRetrieves a list of benefit rate adjustment rules for a company and their basic information.
List BTO BalancesRetrieves a list of PTO balances.
List Budget Organizations for a PositionRetrieves a list of budget organization allocations for a position.
List Company-Level AdministratorsRetrieves a list of company-level administrator roles associated with a person.
List Deduction ClassesRetrieves a list of Deduction Class EDT Codes.
List DepartmentsReturns all the employer departments for a specific employer.
List Dependent DataRetrieves a list of dependents.
List Dependent EnrollmentsRetrieves a list of dependent enrollments for a person.
List Direct ReportsRetrieves a list of a person's directly subordinate positions and the people occupying them.
List Disability StatusRetrieves a list of a person's disability status data.
List EDT CodesRetrieves a list of EDT codes.
List Emergency ContactsRetrieves a list of a person's emergency contacts and all existing phone numbers for each of those contacts.
List Employee Direct DepositsGets a list of direct deposits for a given employee.
List Employee EarningsGets a list of a specific employee's earnings.
List Employee Tax ReasonsRetrieves a list of employee tax reasons.
List Employee TaxesGets a list of employee taxes.
List Employee User Defined DataGets a list of user defined data.
List Employee Worker CompGets the details of a specific employee worker's comp object.
List EmployeesRetrieves a list of employees.
List Employer DeductionsRetrieves a list of employer deductions.
List Employer DocumentsReturns all the employer documents for a specific employer.
List Employer JobsReturns all the jobs of a specific employer.
List Employer NotesRetrieves a list of employer notes.
List Employer ProjectsReturns all the projects of a specific employer.
List Financial Plan DeductionsRetrieves a list of earnings by employee.
List Financial Plan EarningsRetrieves a list of earnings by employee.
List Financial Plan ElectionsRetrieves a list of financial plan elections.
List Frequency CodesRetrieves the frequency code lookup table entries.
List Garnishment PayeesRetrieves a list of garnishment payees.
List Job FamilyRetrieves a list of a company's job family data.
List Job Workers Compensation ProfilesRetrieves a list of job workers compensation profiles.
List JobsRetrieves a list of a company's job data.
List Location Scoped AdministratorsRetrieves a list of Location Scoped Administrator role assignments associated with a person.
List LocationsRetrieves a list of company locations.
List Managing PositionsRetrieves a list of managing positions.
List Marital StatusesRetrieves a list of marital statuses.
List Organization IdentitiesRetrieves a list of the identifiers for the organizations of all classes within a company.
List Organization Scoped AdministratorsRetrieves a list of Organization Scoped Administrator role assignments.
List OrganizationsRetrieves a list of the organizations of all types in the company.
List Pay Period Match CodesRetrieves a list of pay period match codes.
List Pay ProcessesRetrieves a list of pay processes.
List Pay Time Control BatchesRetrieves a list of Pay Time Control batches.
List Pay Unit EDT RelationshipsRetrieves a list of Pay Unit EDT relationships.
List Pay Unit PeriodsRetrieves a list of pay unit periods.
List Pay Unit Scoped AdministratorsRetrieves a list of Pay Unit Scoped Administrator role assignments.
List Pay UnitsRetrieves a list of company pay units.
List Payroll EntriesGets a list of payroll entries, IDs, or the number of entries.
List PeopleRetrieves a list of people in the company and their basic profile information.
List Person Benefit PlansRetrieves a list of Person Benefit Compensation Plan (aka Benefit Program) records for a person.
List Person CompensationRetrieves a list of compensation records for a person.
List Person Compensation TotalRetrieves the employee compensation history for a company.
List Person Direct DepositsRetrieves a list of person direct deposits.
List Person EmailsRetrieves a list of email contacts for a person.
List Person EmploymentRetrieves a list of employment status records for a person.
List Person IdentitiesRetrieves a list of identities for a person.
List Person LocationsRetrieves a list of locations associated with a person.
List Person Misc DeductionsRetrieves a list of miscellaneous deductions for a person.
List Person NamesRetrieves a list of names for a person.
List Person New Hire Reporting StatusRetrieves a list of a person's new hire reporting status data.
List Person PaymentsRetrieves a list of employees and their respective payments.
List Person PayrollRetrieves a list of employees and their respective pay unit assignments.
List Person PhoneRetrieves a list of phone numbers for a person.
List Person PositionsRetrieves a list of positions for a person.
List Person Tax ElectionsRetrieves a list of person tax elections, each including a set of election parameters.
List Person Tax PaymentsRetrieves a list of person tax payments.
List Person TimeRetrieves a list of time information for a person.
List Person Veteran StatusRetrieves a list of a person's veteran status data.
List Person VitalsRetrieves a list of demographic information for a person.
List Position Comp Plan TagsRetrieves a list of position comp plan tag assignments.
List Position LocationsRetrieves a list of position locations.
List Position MatricesRetrieves a list of position matrices for an organization.
List Position OrganizationsRetrieves a list of position organizations.
List Position Plan CompensationRetrieves a list of position plan compensation.
List Position StructuresRetrieves a list of manager-to-subordinate position relationships.
List PositionsRetrieves a list of positions.
List Positions Comp PlanRetrieves a list of position comp plan assignments.
List Salary Grade RangesRetrieves a list of salary grade ranges.
List Salary Grade RegionsRetrieves a list of salary grade regions.
List Salary GradesRetrieves a list of salary grades.
List Salesforce InvoicesRetrieves invoice data for a given service and business unit.
List Salesforce Price for EmployerGets price data for a given service and business unit.
List Target EarningsRetrieves a list of a person's target earnings data.
List Tax Control BatchesRetrieves a list of tax control batches.
List Web Service Process ExecutionsRetrieves a list of executing external web service process executions.
List Welcome EmailsRetrieves a list of people who have received a welcome message.
List Workers' Compensation CodesRetrieves a list of workers' compensation codes.
List Workers' Compensation PlansRetrieves a list of workers' compensation plans.
List Workers' Compensation RatesRetrieves workers' compensation rates from the service.
Update Activity CodeUpdates an existing activity code.
Calculate Payroll EntriesCalculates payroll entries for employee payments and deductions.
Create a Benefit PlanCreates a benefit plan.
Create a Benefit Rate Adjustment DescriptionCreates a new benefit rate adjustment description.
Create a Company Workers PlanCreates a new company workers plan.
Create a Company-Level AdministratorCreates or updates a company-level administrator's role assignment.
Create a Compensation PlanCreates a new compensation plan.
Create a Financial Plan ElectionCreates a financial plan election for a user.
Create a LocationCreates a new location.
Create a Marital StatusCreates a new marital status for a person.
Create a Pay UnitCreates or updates a pay unit in the system.
Create a PersonCreates a new person.
Create a PTO PlanCreates a new PTO plan.
Create a Tax Control BatchCreates a new tax control batch.
Create a Workers' Compensation CodeCreates a new record for a company's Workers' Compensation Code.
Create a Workers' Compensation RateCreates a new record for a company's Workers' Compensation rate.
Create Additional EarningsCreates new additional earnings.
Create an Emergency ContactCreates a new emergency contact.
Create an EmployeeCreates a new employee in the system.
Create an OrganizationCreates a new organization in the system.
Create Dependent DataCreates a new dependent data entry.
Create Employer DocumentsCreates a new employee document.
Create or Update a Benefit Rate Adjustment AmountCreates a new benefit rate adjustment amount or updates an existing one.
Create or Update a GarnishmentAdds and modifies all current garnishments of an employee.
Create or Update a Garnishment PayeeCreates or updates an existing garnishment payee.
Create or Update a JobCreates or updates an existing company job.
Create or Update a Job FamilyUpdates an existing company job family.
Create or Update a Job Workers Compensation ProfileCreates or updates an existing job workers compensation profile.
Create or Update a Location-Scoped AdministratorCreates a new location-scoped administrator role assignment if it doesn't exist or updates an existing role assignment for a person if it exists.
Create or Update a Managing PositionCreates or updates a managing position.
Create or Update a Pay ProcessCreates or updates a pay process.
Create or Update a Pay Time Control BatchCreates or updates an existing pay time control batch.
Create or Update a Pay Unit EDT CodeCreates or updates a pay unit EDT code.
Create or Update a Pay Unit EDT RelationshipCreates or updates a pay unit EDT relationship.
Create or Update a Pay Unit PeriodCreates or updates a pay unit period.
Create or Update a Pay Unit Scoped AdministratorCreates a new Pay Unit Scoped Administrator role assignment if it does not exist, or updates an existing role assignment for a person if it does exist.
Create or Update a Person Benefit ElectionUpdates an existing person benefit election.
Create or Update a Person CompensationCreates or updates a compensation record for a person.
Create or Update a Person Direct DepositCreates or updates an existing person direct deposit.
Create or Update a Person LocationCreates a new location for a person if the location does not exist, or updates an existing location for a person if the location exists.
Create or Update a Person Misc DeductionCreates a new or updates an existing person miscellaneous deduction.
Create or Update a Person NameCreates a new name record for a person if the name does not exist or updates an existing name record if the name exists.
Create or Update a Person New Hire ReportingCreates or updates an existing person new hire reporting.
Create or Update a Person PaymentCreates or updates an existing person payment.
Create or Update a Person PayrollCreates or updates an existing pay unit enrollment for a person.
Create or Update a Person PhoneCreates or updates an existing person's phone.
Create or Update a Person TimeCreates or updates an existing person time record.
Create or Update a Person's AddressCreates a new address for a person if the address does not exist or updates an existing address for the person if it does.
Create or Update a Person's Disability StatusCreates or updates an existing person's disability status.
Create or Update a Person's PasswordCreates or updates an existing person's password.
Create or Update a Person's PositionCreates or updates an existing position record for a person.
Create or Update a Person's Tax ElectionCreates or updates an existing person's tax election record.
Create or Update a Person's Tax PaymentCreates or updates an existing person's tax payment.
Create or Update a PositionCreates a new position or updates an existing one.
Create or Update a Position Comp PlanCreates a new or updates a comp plan assignment for the position.
Create or Update a Position Comp Plan TagCreates a new or updates an existing position comp plan tag.
Create or Update a Position in an OrganizationCreates a new position in an organization or updates an existing one.
Create or Update a Position LocationCreates a new or updates an existing position location.
Create or Update a Position Matrix OrganizationCreates a new or updates an existing position matrix organization.
Create or Update a Position-Organization BudgetCreates a new or updates an existing position-organization relationship.
Create or Update a Salary Grade RegionCreates or updates an existing salary grade region.
Create or Update an Employment RecordCreates or updates an employment record for a person.
Create or Update Dependent EnrollmentCreates or updates an existing dependent enrollment.
Create or Update Organization-Scoped AdministratorsCreates or updates an organization-scoped administrator.
Create or Update Pay Period Match CodeCreates or updates a pay period match code.
Create or Update Person Veteran StatusCreates a new or updates a person's veteran status.
Create or Update Person VitalsCreates or updates an existing vitals record for a person.
Create or Update Personal IdentityCreates or updates a personal identity record in the system.
Create or Update Position Plan CompensationCreates a new or updates an existing position plan compensation.
Create or Update Salary Grade RangesCreates or updates an existing salary grade range.
Create or Update Salary GradesCreates or updates an existing salary grade.
Create or Update Target EarningsCreates or updates existing target earnings.
Create Payroll EntriesCreates new payroll entries.
Delete a Benefit Rate Adjustment AmountRemoves a benefit rate adjustment amount from a record or database.
Delete a Company-Level AdministratorDeletes an existing company-level administrator role assignment.
Delete a Compensation PlanDeletes an existing company organization.
Delete a Garnishment PayeeRemoves an existing garnishment payee.
Delete a JobDeletes an existing company's job.
Delete a Job FamilyDeletes an existing job family.
Delete a Location Scoped AdministratorDeletes an existing Location Scoped Administrator role assignment for a person.
Delete a Pay Period Match CodeDeletes a pay period match code.
Delete a Pay Time Control BatchDeletes an existing pay time control batch.
Delete a Pay Unit EDT RelationshipDeletes an existing Pay Unit EDT relationship.
Delete a Pay Unit PeriodRemoves a pay unit period.
Delete a Pay Unit Scoped AdministratorDeletes a Pay Unit Scoped Administrator role from the system.
Delete a Payroll EntryDeletes an existing payroll entry.
Delete a Person CompensationDeletes an existing compensation record for a person.
Delete a Person Disability StatusRemoves an existing person disability status.
Delete a Person LocationDeletes an existing location for a person.
Delete a Person Misc DeductionDeletes an existing person miscellaneous deduction.
Delete a Person New Hire ReportingDeletes an existing person new hire reporting.
Delete a Person PhoneRemoves an existing person phone.
Delete a Person TimeDeletes an existing person time record.
Delete a Person's Veteran StatusDeletes an existing person's veteran status record.
Delete a PTODeletes a record for a PTO plan description.
Delete a Salary Grade RegionDeletes an existing salary grade region.
Delete an Activity CodeDeletes a record for an activity code.
Delete an Emergency ContactDeletes an existing emergency contact.
Delete an Employer JobDeletes an existing employer job.
Delete an Employer ProjectDeletes an existing employer project.
Delete Dependent EnrollmentRemoves an existing dependent enrollment.
Delete Financial Plan ElectionDeletes a financial plan election for a specific user or account.
Delete Organization Scoped AdministratorDeletes an existing Organization Scoped Administrator role assignment for a person.
Delete Salary Grade RangeDeletes an existing salary grade range.
Delete Salary GradesDeletes an existing salary grade.
Save or Update an Accrual RuleSaves a new accrual rule or updates an existing one.
Submit Payroll EntriesSubmits payroll entries for processing.
Update a Company Workers' PlanUpdates an existing record for a company's Workers' Compensation Plan.
Update a Compensation PlanUpdates an existing compensation plan.
Update a Direct DepositUpdates a direct deposit for a given employee.
Update a LocationUpdates an existing location.
Update a Payroll EntryUpdates an existing payroll entry.
Update a PTOUpdates an existing PTO plan description.
Update a Tax Control BatchUpdates an existing tax control batch.
Update a Web Service Process ExecutionUpdates an existing process execution.
Update a Workers' Compensation CodeUpdates a record for a company Workers' Compensation Code.
Update a Workers' Compensation RateUpdates a record for a company's Workers' Compensation rate.
Update Additional EarningsUpdates an existing additional earnings record.
Update an Emergency ContactUpdates an emergency contact.
Update an EmployeeUpdates an existing employee's information.
Update an Employee AuxiliaryUpdates an existing employee auxiliary.
Update an Employer JobUpdates an existing employer job.
Update an Employer ProjectUpdates an existing employer project.
Update Benefit PlanUpdates a benefit plan.
Update Company OrganizationUpdates an existing company organization.
Update Employee EarningsUpdates earnings for a given employee.
Update Employer DepartmentsUpdates an existing employer department.
Update Financial Plan ElectionUpdates a financial plan election for a specific user.
Update PTO BalanceUpdates an existing person's PTO balance.

How to integrate PrimePay in automation workflow?

3 simple steps to make your PrimePay connected with other apps in automation workflows on WEXTL. Up to 10 minutes integration set up.

STEP 1

Select PrimePay in workflow

Pick PrimePay app in the workflow builder [4] - just one click to select the app.

STEP 2

Connect PrimePay

When prompted, authorize access to PrimePay in WEXTL once. PrimePay credentials are encrypted and never shared with WEXTL. Authorization will be reused in any future API calls [3].

WEXTL wants to integrate with your PrimePay account. Approve?

STEP 3

Build a workflow

Build your workflow with PrimePay yourself or with WEXTL® AI Builder. Connect PrimePay to any available integrations [5], or use HTTP node to go beyond them.

PrimePay

How PrimePay connects and integrates with WEXTL

Save and approve your credentials once — WEXTL® stores authorization information encrypted and reuses the authentication whenever PrimePay app is called in workflows. That allows your hr automations to run without your attention, per defined schedule [7]. Explore documentation [6] for a detailed list of fields that PrimePay supports.

Full PrimePay API documentation

The following table illustrates what fields PrimePay integration require during authorization flow inside our workflow builder [4].

Demonstration of PrimePay connection step inside WEXTL Workflow Builder [4].

Field	Type	Help
API KeyRequired	password	Obtaine your API key through an authorized Company Administrator for the company you wish to obtain access for.
User IDRequired	text	User ID.
PasswordRequired	text	Password for the API.

Connect PrimePay to popular apps on WEXTL

Enter a name of the other app you want to sync with PrimePay below. Click on selected app to explore integration options with PrimePay. If the app you search for is not available in WEXTL yet, you can use HTTP node [10] instead to integrate it directly.

Example automation with PrimePay integration

Select Watch Person Benefit Plan trigger from PrimePay - this will be a starting point in your automation. Whenever event happens in PrimePay, workflow will start [7] from Watch Person Benefit Plan node.

Search for Create a Benefit Plan, connect it as the next step of integration sequence. You can use filters between Watch Person Benefit Plan and Create a Benefit Plan, so only important data pass from Watch Person Benefit Plan to the next step. WEXTL gives you full control over the process of PrimePay automation. All parts of workflow are visible on the canvas [4].

PrimePay on WEXTL has 283 modules for combining hr automations. Explore PrimePay documentation for more.

Video slide demonstrates how Watch Person Benefit Plan and Create a Benefit Plan nodes are used in PrimePay workflow.

Video slide demonstrates how Watch Person Benefit Plan and Create a Benefit Plan [6] nodes are used in PrimePay workflow.

Frequently asked questions

Common questions about automating PrimePay in your workflows.

PrimePay has 58 triggers, including "Watch Activity Code", "Watch Benefit Plan", and "Watch Benefit Plan Data", and more. Triggers are start points of the workflow, and automations may start from them.

Integration has 225 actions, including "Create an Activity Code", "Get an Employer Document", and "List Activity Codes", and more. Refer to our PrimePay Documentation for detailed inputs and outputs.

No. Most automations are built visually on the canvas by picking triggers, actions, and mapping fields. You can add custom JavaScript with Functions when advanced logic is needed — but our customers do that in rare cases [4].

Yes. Connections are authenticated per account, credentials are encrypted at rest, and you can enforce approvals and team-level access controls on any automation.

The PrimePay integration on WEXTL runs directly on its vendor public API — every field name, authentication method, and rate limit is controlled by PrimePay official API and covered in documentation [3]. WEXTL handles the request signing and pagination for you.

Absolutely. Where PrimePay provides native webhooks, you can use instant triggers to eliminate polling delay. For custom webhooks, WEXTL offers Custom Webhook node, so you can start automation whenever PrimePay or any other service sends event to webhook URL.

WEXTL is an AI-first visual canvas. The platform allows you to describe automation in plain text — and AI will wire nodes for PrimePay inside the workflow builder [4]. You can also use built-in workflow nodes (AI Agent, Human in the Loop, Condition, Aggregate Results) in pair with PrimePay modules to craft complex integration flows with branches, filtering, and conditional logic. There are absolutely no limits of what you can build.

References

List of sources used to gather information about the PrimePay integration.

PrimePay integration source code, module specs and credentials implementation.
Internal PrimePay integration documentation, structured input and output parameters, scopes, and authentication methods.
Official PrimePay vendor API documentation — used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
WEXTL® Apps Library
WEXTL® PrimePay App Documentation
WEXTL® Workflow Scheduler
WEXTL® HTTP node documentation

PrimePay Integration

Supported triggers and actions for PrimePay integration