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

# List webhooks

> List the organization's webhook subscriptions.



## OpenAPI

````yaml /openapi.json get /v1/webhooks
openapi: 3.1.0
info:
  title: Gobare Agent API
  version: v1
  description: >-
    Programmatic access to Gobare coding-agent sessions. Conceptually aligned
    with OpenAI's Agents API; deliberately not wire-compatible with it. See the
    divergence list in the product documentation.
servers:
  - url: https://api.{domain}
    variables:
      domain:
        default: gobare.dev
security: []
paths:
  /v1/webhooks:
    get:
      summary: List webhooks
      description: List the organization's webhook subscriptions.
      operationId: get_webhooks
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: How many to return, 1–100. Default 20.
        - name: after
          in: query
          required: false
          schema:
            type: string
          description: >-
            The `last_id` of the previous page. A cursor this collection cannot
            place — expired, deleted, or never issued — answers with an empty
            page rather than starting over, so a paging loop ends instead of
            repeating itself.
      responses:
        '200':
          description: List the organization's webhook subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookSubscriptionList'
        '400':
          description: >-
            `invalid_request`. A query parameter this endpoint does not take.
            Refused rather than ignored, because an ignored filter answers with
            everything and looks like a filter that matched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The access token is missing, unrecognised, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The token is valid but may not perform this call. The message names
            the scope it wanted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            No such endpoint, or the public API is not enabled on this
            deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            `rate_limit_exceeded`. The token is past its allowance for this
            bucket. Honour `Retry-After`; the `x-ratelimit-*` headers on every
            response say how close you were.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: An unexpected error. Quote the request id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - accessToken: []
components:
  schemas:
    WebhookSubscriptionList:
      type: object
      required:
        - object
        - data
      properties:
        object:
          type: string
          const: list
          description: >-
            Always `list`. Names the shape, so a value can be identified without
            knowing which call returned it.
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscription'
    Error:
      type: object
      required:
        - error
      description: Every refusal this API makes, in one shape.
      properties:
        error:
          description: Always present on a failure, and the only thing present.
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - authentication_error
                - permission_denied
                - not_found
                - method_not_allowed
                - conflict
                - queue_full
                - rate_limit_exceeded
                - project_limit_exceeded
                - context_length_exceeded
                - provider_error
                - provider_unauthorized
                - sandbox_error
                - sandbox_unavailable
                - directory_unavailable
                - workspace_recovery_failed
                - bridge_incompatible
                - internal_error
            message:
              type: string
            request_id:
              type: string
              description: >-
                Also on the x-request-id header. Quote it when reporting a
                problem.
    WebhookSubscription:
      type: object
      required:
        - object
        - id
        - url
        - events
        - active
      description: >-
        An endpoint subscribed to session events. The secret is returned only
        when it is created.
      properties:
        object:
          type: string
          const: webhook.subscription
          description: >-
            Always `webhook.subscription`. Names the shape, so a value can be
            identified without knowing which call returned it.
        id:
          type: string
        url:
          type: string
          description: Where deliveries are POSTed. https only.
        events:
          type: array
          items:
            type: string
          description: What this endpoint is subscribed to.
        active:
          type: boolean
        created_at:
          type: integer
          description: Unix milliseconds.
        delivery:
          $ref: '#/components/schemas/WebhookDeliveryHealth'
    WebhookDeliveryHealth:
      type: object
      description: >-
        Whether this endpoint is actually receiving anything. Deliveries are
        retried six times over roughly nine hours and then given up on; without
        this, an integration whose endpoint broke found out by noticing it had
        stopped receiving events — the one thing webhooks exist to stop anyone
        having to do.
      required:
        - pending
        - dead
      properties:
        pending:
          type: integer
          description: Owed and not yet delivered, including ones waiting on a retry.
        dead:
          type: integer
          description: >-
            Given up on after six attempts. A number that keeps climbing means
            the endpoint is broken, not busy.
        last_error:
          type:
            - string
            - 'null'
          description: >-
            Why the most recent one was given up on, as we saw it — a status, or
            the transport error.
        last_failed_at:
          type:
            - integer
            - 'null'
          description: >-
            Unix milliseconds of that delivery. Null when none has been given up
            on.
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      description: >-
        A `gbr_pat_` access token. Scopes are recorded on the token when it is
        minted.

````