PApaylocity
Events

Get Event [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 a single webhook event by its unique id. Supports optional includes to retrieve the associated subscription details and delivery logs in a single request.

Use this endpoint to:

  • Inspect the full details of a specific webhook event
  • Retrieve delivery logs to diagnose failed or retried events
  • Include subscription configuration alongside event data for audit or debugging purposes
get/apiHub/webhooks/v1/events/{id}

Request

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

Path parameters

idstring uuid required

The unique identifier of the webhook event to retrieve. Must be a valid UUID.

Query parameters

includestring

A comma-separated list of related resources to include in the response. Supported values: logs (delivery attempt logs), subscription (the subscription configuration associated with this event).

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

OK

idstring uuid

The unique identifier of the webhook event.

correlationIdstring uuid

A correlation identifier used to trace the event across systems.

subscriptionIdstring uuid

The unique identifier of the subscription the event was delivered to.

subscriptionNamestring nullable

The name of the subscription the event was delivered to.

clientIdstring nullable

The ID of the API credentials that own the subscription.

applicationIdstring uuid nullable

The ID of the application associated with the API credentials.

typestring nullable

The event type (e.g. employee.person.v1, employee.assignment.v1).

mutationstring nullable

The type of change made to the resource (e.g. created, updated, deleted).

timestring date-time

The date and time the event occurred.

dataContentTypestring nullable

The content type of the event payload.

dataobject nullable

The event payload. Structure varies by event type.

statusstring nullable

The delivery status of the event (e.g. Delivered, Failed, Pending).

lastStatusCodestring nullable

The HTTP status code returned by the most recent delivery attempt.

totalAttemptsinteger

The total number of delivery attempts made for the event.

Example response

{
  "logs": [
    {
      "responseCode": "200",
      "durationMs": 142
    }
  ],
  "subscription": {
    "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.