Webhooks Overview

Create, manage, and monitor webhook subscriptions

🚧

Early Adopter Opportunity

The Webhooks API is in early adoption and available only to approved early adoption (EA) partners and customers. 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.

Introduction

The Webhooks API lets you create, manage, and monitor subscriptions — configurations that tell Paylocity which events you want to receive and where to send them. Once a subscription is active, Paylocity pushes a JSON payload to your endpoint any time a subscribed event occurs, so your integration doesn't have to poll for changes.

Using the Webhooks API, you can:

  • Subscribe to specific event types, such as employee record or assignment changes, punch details, and pay type transactions
  • Choose how deliveries to your endpoint are secured (HMAC request signing)
  • Manage the full lifecycle of a subscription (create, read, update, pause, delete)
  • Query the history of events that were sent, including delivery status and per-attempt logs, so you can audit or recover from missed deliveries

How It Works

  1. You create a subscription specifying a name, one or more eventTypes, the HTTPS url that will receive deliveries, and an auth configuration used to secure the delivery.
  2. When a subscribed event occurs in Paylocity, an event record is generated and queued for delivery to every active subscription for that event type.
  3. Paylocity sends an HTTP POST with a JSON payload to your url. The payload follows a CloudEvents-style shape (id, type, time, data, etc. — see Webhooks-Events).
  4. Your endpoint should respond quickly with a 2xx status to acknowledge receipt. See Webhooks-Events for how delivery status and retries are tracked.

The URL you provide must be publicly reachable over HTTPS. Use separate subscriptions/URLs for sandbox and production so test traffic never lands on production data, and don't rely solely on webhook payloads for your source of truth — call the relevant API to confirm details when it matters.

Endpoints at a Glance

MethodPathDescription
POST/apiHub/webhooks/v1/subscriptionsCreate a subscription
GET/apiHub/webhooks/v1/subscriptionsList subscriptions
GET/apiHub/webhooks/v1/subscriptions/{id}Read a single subscription
PATCH/apiHub/webhooks/v1/subscriptions/{id}Update a subscription (JSON Patch)
DELETE/apiHub/webhooks/v1/subscriptions/{id}Delete a subscription
GET/apiHub/webhooks/v1/eventsList webhook events that were sent

See Webhooks-Subscriptions for the subscription walkthrough and Webhooks-Events for reading delivery history.

Webhooks Access

Access to Paylocity webhooks is controlled in two ways:

  • Webhooks API access determines what you can do with webhook subscriptions. Access to view existing subscriptions and events is separate from access to create, update, or manage subscriptions.
  • Event type access determines which webhook events your application can subscribe to. Access is granted by event type, so access to one event does not automatically include access to others. For example, access to employee.person.v1 does not include access to employee.assignment.v1.

See Webhooks-Event Types forr the full list of available event types.

Important: Your application can only subscribe to event types it has been granted access to. If you attempt to create or update a subscription for an event type you do not have access to, the API returns a 403 Forbidden response.

Requesting access

Webhook API and event type access are granted as part of your Paylocity Marketplace partnership or integration setup.

If you need Webhooks API access or access to additional event types please contact your technical liason or refer to our Getting Started guide.