PApaylocity
Subscriptions

Get Subscriptions [Batch]

🚧 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

Retrieves the current webhook subscription(s) configured for the authenticated client. This endpoint allows clients to review their active webhook settings, including subscribed event types, target URL, authentication configuration, and delivery settings.

Use this endpoint to:

  • View all existing webhook subscriptions

  • Confirm which event types are currently enabled

  • Validate the delivery endpoint URL and retry settings

This endpoint helps ensure transparency and accuracy in managing webhook integrations with the Paylocity platform.

get/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

Query parameters

limitinteger

Specifies the maximum number of webhook subscriptions to return in the response. Use this parameter to control the page size for paginated results. The default and maximum value is 100.

filterstring

A filter expression to limit the webhook subscriptions returned. Filterable fields: status (eq), clientId (eq, ne, in), applicationId (eq). Example: status eq 'Active'.

includeTotalCountboolean

When provided and set to true will cause the API to return the X-Pcty-Total-Count header in the response which will be set to the total number of resources available even if only a subset of those were returned. The default is false.

offsetinteger

The number of resources to skip when returning paginated results. The default is 0.

sortstring

A comma-separated, xpath-like formatting string that identifies the fields that you want the API to use for sorting the resources when they are returned. The default value can vary from API to API.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

idstring uuid

The unique identifier of the webhook subscription.

clientIdstring uuid

The ID of the API credentials that own the subscription.

applicationIdstring uuid

The ID of the application associated with the API credentials.

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.

createdAtstring date-time nullable

The date and time the subscription was created.

Example response

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Employee Updates Subscription",
    "status": "ACTIVE",
    "url": "https://my-app.example.com/webhooks/paylocity",
    "auth": {
      "type": "HMAC"
    }
  }
]

Changes

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