GuidesRecipesAPI ReferenceChangelog
Login
API Reference
Login

Get Events [Batch]

get
https://dc1demogwext.paylocity.com/apiHub/webhooks/v1/events
šŸš§

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.

Query Params
string

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'.

int32
0 to 25

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.

string

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

boolean

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.

int32

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

string

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.

Responses

401

Unauthorized

Updated 20 days ago

Whatā€™s Next

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoadingā€¦
Response
Choose an example:
application/json

Updated 20 days ago

Whatā€™s Next

Did this page help you?