Subscriptions

Create Subscription

🚧 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.

post/apiHub/webhooks/v1/subscriptions

Request

Base URL
dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
URL
dc1demogwext.paylocity.com/apiHub/webhooks/v1/subscriptions
Auth
HTTP bearer

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

namestring required

The name of the subscription

eventTypesstring[] 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.

urlstring required

The HTTPS URL where webhook events will be delivered

Example request

{
  "name": "Employee Updates Subscription",
  "auth": {
    "type": "hmac"
  },
  "url": "https://my-app.example.com/webhooks/paylocity"
}

Response

Created

idstring uuid

The unique identifier of the webhook subscription.

namestring nullable

The name of the webhook subscription.

statusstring nullable

The current status of the webhook subscription. Allowable Values: ACTIVE, DISABLED, DEACTIVATED, UNREACHABLE, PENDING_VERIFICATION.

eventTypesstring[] nullable

List of event types the subscription receives (e.g. employee.person.v1, employee.assignment.v1).

urlstring nullable

The URL where webhook events are delivered.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "ACTIVE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.