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

# Get Webhook Subscription



## OpenAPI

````yaml api-reference/openapi.json GET /v1/webhooks/subscriptions/{webhook_subscription_id}
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}:
    get:
      tags:
        - webhooks
      operationId: get_v1_webhooks_subscriptions_webhook_subscription_id
      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
      responses:
        '200':
          description: Webhook subscription retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhookSubscriptionResponse'
              example:
                webhookEventTypes:
                  - PAYROLL_PROCESSED
                  - UPDATE_GROUP_PROCESSED
                path: https://example.com/webhooks
                createdAt: '2026-01-01T00:00:00.000Z'
                active: true
        '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 subscription 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:
    GetWebhookSubscriptionResponse:
      type: object
      properties:
        webhookEventTypes:
          description: The event types the subscription receives for its parent entity
          minItems: 1
          type: array
          items:
            type: string
            enum:
              - EMPLOYEE_CENSUS_HIRED
              - EMPLOYEE_CENSUS_TERMINATED
              - EMPLOYEE_CENSUS_UPDATED
              - PAYROLL_PROCESSED
              - UPDATE_GROUP_PROCESSED
        path:
          description: Destination URL for webhook notifications
          type: string
          format: uri
        createdAt:
          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)))$
        active:
          description: >-
            Represents whether the subscription is active and receiving webhook
            letters
          type: boolean
      required:
        - webhookEventTypes
        - path
        - createdAt
        - active
      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 <token>.

````