Create Subscription

post

https://dc1demogwext.paylocity.com/apiHub/webhooks/v1/subscriptions

🚧
Early Access API Version
This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

Creates a new webhook subscription, allowing clients to receive real-time event notifications from the Paylocity platform. Clients specify the event types they want to subscribe to and provide a secure endpoint URL to which Paylocity will send event payloads. Webhook subscriptions created through this endpoint allow external systems to stay in sync with changes to employee data, assignments, compensation, and more.

Body Params

name

string

required

length between 0 and 100

The name of the subscription

eventTypes

array of strings

required

List of event types to subscribe to. Supported values: employee.person.v1, employee.assignment.v1, employee.assignment.status.v1, employee.assignment.payrate.v1, employee.assignment.position.v1, employee.assignment.reviewer.v1, employee.assignment.supervisor.v1, employee.assignment.costcenter.v1, employee.assignment.workcontact.v1, employee.assignment.worklocation.v1, employee.paytypetransaction.v1, employee.workedshift.v1.

eventTypes*

auth

object

Authentication Configuration

Exactly one authentication object must be provided, based on the value of the type field:

HMAC authentication – populate the hmac object.

Future authentication protocols may introduce additional mutually exclusive objects.

url

string

required

length ≥ 1

The HTTPS URL where webhook events will be delivered

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

Create Subscription

Early Access API Version

Authentication Configuration

What’s Next

What’s Next

Authentication Configuration

201Created

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

What’s Next

What’s Next