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

# Get a webhook

> One webhook. `status: "paused"` means nothing is being sent: deliveries failed for 3 days, or an owner paused it. Register the URL again to resume a webhook paused for failing; one an owner paused waits for an owner to resume it.

An API key only sees the webhooks it registered. A webhook added in the dashboard or by another key is not listed, and its id answers 404.



## OpenAPI

````yaml /api-reference/openapi.json get /webhooks/{id}
openapi: 3.1.0
info:
  title: miniDesk API
  version: 1.0.0
  description: >-
    Create and work support tickets from your own systems. Every response
    carries an `X-Request-Id`; quote it when reporting a problem.
servers:
  - url: https://api.minidesk.ai/v1
security:
  - bearerAuth: []
paths:
  /webhooks/{id}:
    get:
      tags:
        - Webhooks
      summary: Get a webhook
      description: >-
        One webhook. `status: "paused"` means nothing is being sent: deliveries
        failed for 3 days, or an owner paused it. Register the URL again to
        resume a webhook paused for failing; one an owner paused waits for an
        owner to resume it.


        An API key only sees the webhooks it registered. A webhook added in the
        dashboard or by another key is not listed, and its id answers 404.
      operationId: getWebhook
      parameters:
        - name: id
          in: path
          required: true
          description: The webhook's id, as returned when you registered it.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The webhook.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '401':
          description: Missing, malformed, or revoked credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Unknown id, or a resource belonging to another workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the rate limit. See the `Retry-After` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        url:
          type: string
        events:
          type: array
          items:
            type: string
            enum:
              - conversation.created
              - message.received
              - conversation.status_changed
              - conversation.assigned
        status:
          type: string
          enum:
            - active
            - paused
        created_at:
          type: string
      required:
        - id
        - url
        - events
        - status
        - created_at
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - invalid_credential
                - identity_required
                - identity_invalid
                - forbidden
                - email_unconfirmed
                - seat_unavailable
                - not_found
                - no_account
                - conflict
                - quota_exceeded
                - invalid_transition
                - ai_disabled
                - app_outdated
                - rate_limited
                - internal_error
                - service_unavailable
            message:
              type: string
            field:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API credential from **Settings → API**, sent as `Authorization:
        Bearer mdsk_api_...`. Issued per workspace and shown once.

````

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