> ## Documentation Index > Fetch the complete documentation index at: https://developer.payrollintegrations.com/llms.txt > Use this file to discover all available pages before exploring further. # List Webhook Event Data > Returns the data records associated with a webhook event, paginated. The item shape depends on the event type (payroll, census, or update group). export const PaginationInfo = ({defaultSortField, sortFields = [], maxLimit = 100, defaultLimit = 20}) => { return <>

Pagination & Sorting

{(maxLimit || defaultLimit) && } ; }; The item shape depends on the event's `eventType`: | Event Type | Data Shape | | :------------------------------------------------------------------------------- | :--------------------------------------------- | | `PAYROLL_PROCESSED` | `{ payrollRecordId, connectionId, createdAt }` | | `EMPLOYEE_CENSUS_HIRED`, `EMPLOYEE_CENSUS_UPDATED`, `EMPLOYEE_CENSUS_TERMINATED` | `{ employeeDataId, connectionId, createdAt }` | | `UPDATE_GROUP_PROCESSED` | `{ updateGroupId, status, createdAt }` | Census events (`EMPLOYEE_CENSUS_HIRED`, `EMPLOYEE_CENSUS_UPDATED`, `EMPLOYEE_CENSUS_TERMINATED`) are batched per run rather than per employee, so a single event can have many data rows — one per affected employee. ## OpenAPI ````yaml api-reference/openapi.json GET /v1/webhooks/subscriptions/{webhook_subscription_id}/events/{webhook_event_id}/data openapi: 3.0.3 info: title: Payroll Integrations Public API version: 1.0.0 description: Public API for Payroll Integrations platform license: name: MIT servers: - url: https://api.payrollintegrationsapp.com description: Production security: [] tags: - name: auth - name: employer-identifiers - name: meta - name: payroll-connections - name: payroll-platforms - name: roles - name: users - name: webhooks paths: /v1/webhooks/subscriptions/{webhook_subscription_id}/events/{webhook_event_id}/data: get: tags: - webhooks summary: List data for a webhook event description: >- Returns the data records associated with a webhook event, paginated. The item shape depends on the event type (payroll, census, or update group). operationId: >- get_v1_webhooks_subscriptions_webhook_subscription_id_events_webhook_event_id_data parameters: - name: webhook_subscription_id in: path required: true schema: description: Unique identifier of the webhook subscription type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier of the webhook subscription example: 00000000-0000-0000-0000-000000000000 - name: webhook_event_id in: path required: true schema: description: Unique identifier of the webhook event type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier of the webhook event example: 11111111-1111-1111-1111-111111111111 - name: limit in: query required: false schema: description: Maximum number of records to return type: integer minimum: 1 maximum: 4294967295 description: Maximum number of records to return - name: offset in: query required: false schema: description: Number of records to skip from the beginning type: integer minimum: 0 maximum: 4294967295 description: Number of records to skip from the beginning - name: sort in: query required: false schema: description: >- Comma-separated list of fields to sort by. Prefix with - for descending order type: string pattern: ^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$ description: >- Comma-separated list of fields to sort by. Prefix with - for descending order responses: '200': description: Webhook event data retrieved successfully content: application/json: schema: $ref: '#/components/schemas/ListWebhookEventDataResponse' example: data: - payrollRecordId: 22222222-2222-2222-2222-222222222222 connectionId: 33333333-3333-3333-3333-333333333333 createdAt: '2026-01-01T00:00:00.000Z' meta: currentCount: 1 filters: {} limit: 20 offset: 0 sort: createdAt totalCount: 1 headers: Link: schema: type: string pattern: >- ^(?:<[^>]+>;\s*rel="(?:self|first|last|prev|next)"(?:,\s+<[^>]+>;\s*rel="(?:self|first|last|prev|next)")*)$ '400': description: Invalid request parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Invalid or missing token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: WWW-Authenticate: schema: description: Authentication challenge (Bearer) type: string description: Authentication challenge (Bearer) '403': description: Insufficient permissions or access denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Webhook event not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' headers: Retry-After: schema: description: Number of seconds to wait before retrying type: string description: Number of seconds to wait before retrying '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ListWebhookEventDataResponse: type: object properties: data: type: array items: anyOf: - type: object properties: payrollRecordId: description: Identifier of the processed payroll record type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ connectionId: description: >- Identifier of the payroll connection this data belongs to, when applicable type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: description: When this data record was created (the sort key) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - payrollRecordId - createdAt additionalProperties: false - type: object properties: employeeDataId: description: Identifier of the affected employee record type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ connectionId: description: >- Identifier of the payroll connection this data belongs to, when applicable type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ createdAt: description: When this data record was created (the sort key) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - employeeDataId - createdAt additionalProperties: false - type: object properties: updateGroupId: description: Identifier of the processed update group type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ status: description: Outcome of the update group processing type: string enum: - FAILED - SUCCESS createdAt: description: When this data record was created (the sort key) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - updateGroupId - status - createdAt additionalProperties: false meta: type: object properties: currentCount: description: Number of results in current page type: integer minimum: 0 maximum: 4294967295 filters: description: Applied filters with field names and operators type: object additionalProperties: type: object properties: eq: type: string ne: type: string gt: type: string gte: type: string lt: type: string lte: type: string in: type: array items: type: string not_in: type: array items: type: string like: type: string not_like: type: string contains: type: string not_contains: type: string empty: type: string not_empty: type: string additionalProperties: false limit: description: Maximum number of results per page type: integer minimum: 0 maximum: 4294967295 offset: description: Number of results to skip type: integer minimum: 0 maximum: 4294967295 sort: description: Sort order type: string pattern: ^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$ totalCount: description: Total number of results type: integer minimum: 0 maximum: 9007199254740991 required: - currentCount - filters - limit - offset - sort - totalCount additionalProperties: false required: - data - meta additionalProperties: false ErrorResponse: type: object properties: message: description: Human-readable error message type: string errors: description: Array of specific error details type: array items: type: string required: - message - errors additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer . ````