> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List event types

> Every event type you can subscribe to, with a description and the API version it arrived in.



## OpenAPI

````yaml /api-reference/specs/webhooks.json get /event-types
openapi: 3.1.1
info:
  title: Webhooks Service
  description: >-
    Outbound webhooks for FlowPayroll: register an endpoint, subscribe to event
    types, manage signing secrets, inspect the delivery log and replay.
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/webhooks
security:
  - X-Auth-Token: []
tags:
  - name: Alert contacts
  - name: Delivery log
  - name: Endpoint subscriptions
  - name: Endpoints
  - name: Event types
  - name: Events
  - name: Replays
paths:
  /event-types:
    get:
      tags:
        - Event types
      summary: List event types
      description: >-
        Every event type you can subscribe to, with a description and the API
        version it arrived in.
      operationId: ListEventTypes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEventDescriptorListResponseBody'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectResponseBody'
components:
  schemas:
    WebhookEventDescriptorListResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/WebhookEventDescriptorListContentResponse'
        validationIssues:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssue'
      additionalProperties: false
    ObjectResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          $ref: '#/components/schemas/ObjectContentResponse'
        validationIssues:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssue'
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
      additionalProperties: false
    WebhookEventDescriptorListContentResponse:
      type: object
      properties:
        data:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/WebhookEventDescriptor'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
      additionalProperties: false
    ObjectContentResponse:
      type: object
      properties:
        data:
          type: 'null'
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          type: 'null'
      additionalProperties: false
    WebhookEventDescriptor:
      type: object
      properties:
        type:
          type: string
        family:
          enum:
            - PayRun
            - Payslip
            - Leaver
            - PForms
            - CourtOrders
            - StatutoryPay
            - Holiday
            - Journal
            - Pension
            - EmailDelivery
            - Operational
            - Employee
            - Rti
            - LineItem
            - Report
            - RecurringLineItems
            - HmrcNotices
            - Salary
            - Integrations
            - Billing
            - Payment
          type: string
        description:
          type: string
        status:
          enum:
            - Planned
            - Available
            - Deprecated
          type: string
        sinceApiVersion:
          type: string
        subscribable:
          type: boolean
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type:
            - 'null'
            - string
          description: >-
            Cursor for the next page, present only when more results follow and
            null on the last page. Pass it back unmodified to continue; it is
            opaque and short-lived, so do not store it.
      additionalProperties: false
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.