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

# Get webhook filters by webhook ID

> Returns all filters for a specific webhook



## OpenAPI

````yaml /openapi/beyond-ai/webhooks-api.yaml get /webhook-filters/webhook/{webhookId}
openapi: 3.1.0
info:
  title: Webhooks API
  version: 1.0.0
  description: >-
    # Webhooks API


    ## Overview

    The Alpha Webhooks API allows you to register endpoints that will receive
    real-time notifications when Caliper events are processed by our system.
    This enables your application to react immediately to learning events
    without the need for polling or direct database access.



    # Authentication


    ## Guide


    Most endpoints require authentication using the `Authorization: Bearer
    <token>` header.


    The token can be obtained with:


    ```

    curl -X POST
    https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com/oauth2/token
    \

    -H "Content-Type: application/x-www-form-urlencoded" \

    -d
    "grant_type=client_credentials&client_id=<your-client-id>&client_secret=<your-client-secret>"

    ```


    Use the correct IDP server depending on the environment you're using.


    IDP Server for this environment:

    ```text
      https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com
    ```


    Reach out to the platform team to get a client/secret pair for your
    application.
servers:
  - url: https://caliper.alpha-1edtech.ai
    description: Webhooks API
security:
  - OAuth2: []
tags:
  - name: Webhook Filters
    description: >-
      These are the endpoints to use when creating, updating, and deleting
      webhook filters
  - name: Webhooks
    description: >-
      These are the endpoints to use when creating, updating, and deleting
      webhooks
paths:
  /webhook-filters/webhook/{webhookId}:
    get:
      tags:
        - Webhook Filters
      summary: Get webhook filters by webhook ID
      description: Returns all filters for a specific webhook
      parameters:
        - name: webhookId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Webhook filters retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  filters:
                    type: array
                    items:
                      type: object
                      properties:
                        webhookId:
                          type: string
                          description: >-
                            The unique identifier for the webhook, in UUID
                            format
                          example: 123e4567-e89b-12d3-a456-426614174000
                        filterKey:
                          type: string
                          description: The key to filter on
                          example: sensor
                        filterValue:
                          type: string
                          description: The value to filter on
                          example: sensor123
                        filterType:
                          type: string
                          enum:
                            - string
                            - number
                            - boolean
                          description: The type of the filter value
                          example: string
                        filterOperation:
                          type: string
                          enum:
                            - eq
                            - neq
                            - gt
                            - gte
                            - lt
                            - lte
                            - contains
                            - notContains
                            - in
                            - notIn
                            - startsWith
                            - endsWith
                            - regexp
                          description: The operation to perform on the filter value
                          example: eq
                        active:
                          type: boolean
                          description: Whether the filter is active
                          example: true
                        createdAt:
                          type: string
                          description: The date and time the filter was created
                          example: '2021-01-01T00:00:00.000Z'
                        updatedAt:
                          type: string
                          description: The date and time the filter was last updated
                          example: '2021-01-01T00:00:00.000Z'
                        deletedAt:
                          type:
                            - string
                            - 'null'
                          description: The date and time the filter was deleted
                          example: '2021-01-01T00:00:00.000Z'
                      required:
                        - webhookId
                        - filterKey
                        - filterValue
                        - filterType
                        - filterOperation
                        - active
                        - createdAt
                        - updatedAt
                        - deletedAt
                required:
                  - filters
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            https://purl.imsglobal.org/spec/caliper/v1p1/scope/admin: Admin scope (can call all endpoints)
            https://purl.imsglobal.org/spec/caliper/v1p1/scope/webhook.create: Webhook create scope (can create and update webhooks)
            https://purl.imsglobal.org/spec/caliper/v1p1/scope/webhook.readonly: Webhook readonly scope (can read webhooks)
            https://purl.imsglobal.org/spec/caliper/v1p1/scope/event.create: Event create scope (can create events)
          tokenUrl: >-
            https://prod-beyond-timeback-api-2-idp.auth.us-east-1.amazoncognito.com/oauth2/token

````