Events

Get Events [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 a list of webhook events that have been sent for a specific company. This endpoint allows clients to view event delivery history, including event type, timestamp, and delivery status. It is useful for monitoring webhook activity, auditing, and troubleshooting integrations.

get/apiHub/webhooks/v1/events

Request

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

Query parameters

filterstring

A filter expression to limit the webhook events returned. Filterable fields: subscriptionId (in), type (in), status (in), time (ge, le), applicationId (eq), clientId (eq). Example: status in ('Delivered') and time ge '2024-01-01T00:00:00Z'.

limitinteger

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

includestring

A comma-separated list of related resources to include in the response. Supported values: logs (delivery attempt logs for each event).

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

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

[
  {
    "type": "employee.person.v1",
    "mutation": "updated",
    "status": "Delivered",
    "logs": [
      {
        "responseCode": "200",
        "durationMs": 142
      }
    ]
  }
]

Changes

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