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

# List

> List webhook subscriptions



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /webhooks
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /webhooks:
    get:
      tags:
        - Webhooks
      summary: List
      description: List webhook subscriptions
      operationId: getWebhooks
      responses:
        '200':
          description: Every subscription. Secrets are not included
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webhook'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        name:
          type: string
        url:
          type: string
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEvent'
          default: []
        enabled:
          type: boolean
          default: true
        headers:
          type: object
          additionalProperties:
            type: string
        filter:
          $ref: '#/components/schemas/WebhookFilter'
        failures:
          type: integer
          default: 0
          description: Consecutive failed deliveries. A delivery that lands resets it
        error:
          type:
            - string
            - 'null'
          description: Why it was switched off, when it switched itself off
        last_status:
          type:
            - integer
            - 'null'
        last_delivery_at:
          type:
            - integer
            - 'null'
          example: 1785846207000
        created_by:
          type:
            - string
            - 'null'
        created_at:
          type: integer
          example: 1785846207000
      required:
        - id
        - name
        - url
        - created_at
        - events
        - enabled
        - failures
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    WebhookEvent:
      type: string
      enum:
        - job.created
        - job.started
        - job.completed
        - job.failed
        - job.suspended
        - job.resumed
        - job.removed
        - step.started
        - step.completed
        - step.failed
        - task.started
        - task.completed
        - task.failed
        - node.offline
        - node.online
        - node.error
    WebhookFilter:
      type: object
      properties:
        pool_id:
          type: string
          description: Jobs in this pool, and machines in it
        user_id:
          type: string
          description: >-
            One person's jobs. Job-scoped by nature, so a subscription narrowed
            this way receives no node events
      description: >-
        Narrows a subscription to a pool or an owner. There is deliberately no
        job id: a per-job subscription is one nothing would reap
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

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