---
title: "Get topic definitions"
method: GET
path: "/webhooks/topic-definitions"
tags: ["Topic Definitions"]
---

# Get topic definitions

`GET /webhooks/topic-definitions`

## Request

- Base URL: `https://api.pax8.com/api/v2`
- URL: `https://api.pax8.com/api/v2/webhooks/topic-definitions`
- Auth: none declared

Get all available webhook subscription topic definitions and their filterable conditions

## Query parameters

- `page` integer
- `size` integer
- `search` string
- `sort` string
- `topic` string

## Response `200`

The request has succeeded.

- TopicDefinitionPagedResult: Paged response for topic definitions
  - `content` TopicDefinition[], required: List of topic definitions
    - `topic` string, required: The topic name
    - `name` string, required: Human-readable name of the topic
    - `description` string, required: Description of the topic
    - `availableFilters` WebhookFilterDefinition[], required: Available filters for this topic
      - `action` string, required: Action to filter on
      - `actionDisplayName` string, required: Display name normalizing the action for consistency in presentation
      - `description` string, required: Description of the filter
      - `conditions` FilterConditionDefinition[], required: Available conditions for this filter
        - `field` string, required: Field path to filter on
        - `operator` FilterOperator[], required: Available operators for this field
        - `dataType` string, required: Data type of the field
        - `description` string, required: Description of the field
        - `value` string, required: Example value for the field
    - `samplePayload` WebhookPayload, required: Webhook payload structure
      - `accountId` string, uuid, required: Account ID associated with the event
      - `url` string, required: URL where the webhook was sent
      - `webhookId` string, uuid, required: Webhook ID that sent this payload
      - `sentAt` string, date-time, required: Timestamp when the webhook was sent
      - `webhookTopic` WebhookTopic, required: Topic configuration for a webhook subscription
        - `id` string, uuid, required: Unique identifier for the webhook topic
        - `topic` string, required: The topic name
        - `filters` WebhookFilter[], required: Advanced filtering configuration
          - `action` string, required: Action to filter on
          - `conditions` FilterCondition[], required: List of conditions that must all be true
            - `field` string, required: Field path to filter on
            - `operator` 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'IN' | 'NOT_IN' | 'CONTAINS', required: Filter operator for webhook conditions
            - `value` string[], required: Values to compare against
      - `payloadData` object: The actual event data
  - `number` integer, required: Current page number
  - `size` integer, required: Number of items per page
  - `totalElements` integer, required: Total number of elements
  - `totalPages` integer, required: Total number of pages

## Other responses

- `400`: The request is missing required parameters or has invalid parameters
- `401`: Missing or invalid token
- `403`: User does not have permission to access this resource
- `500`: Server error

---

[API](https://skmtc.dev/pax8/apis/webhooks-api.md) - [All operations](https://skmtc.dev/pax8/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/webhooks-api/revisions/c0951191e943?raw)