PApaylocity
Subscriptions

Get Subscription [Single]

🚧 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 details of a specific webhook subscription using its unique id. This endpoint allows API users to view the configuration of a single subscription, including the target URL, event types, authentication settings, and delivery preferences.

Use this endpoint to:

  • Inspect a specific webhook subscription
  • Validate configuration for a known subscription
  • Support debugging or audit use cases involving webhook delivery

This is useful for clients managing multiple webhook subscriptions and needing granular visibility into individual configurations.

get/apiHub/webhooks/v1/subscriptions/{id}

Request

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

Path parameters

idstring uuid required

The unique identifier of the webhook subscription to retrieve. This value must be a valid UUID and corresponds to the subscription previously created or listed via the 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.