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

# Get a webhook endpoint

> Returns one endpoint, including whether it is enabled and why it was disabled.



## OpenAPI

````yaml /openapi/openapi.json get /v1/webhooks/{id}
openapi: 3.1.0
info:
  contact:
    name: PrintEasy
    url: https://docs.printeasy.adfinite.com
  description: >-
    Cloud printing API: send PDFs and raw jobs to printers attached to computers
    running the PrintEasy agent.
  title: PrintEasy API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.printeasy.adfinite.com
security:
  - ApiKeyAuth: []
  - BasicAuth: []
tags:
  - description: Who you are, your plan and usage
    name: Account
  - description: Machines running the PrintEasy agent
    name: Computers
  - description: Printers reported by agents
    name: Printers
  - description: Submit and track print jobs
    name: Print jobs
  - description: Signed event delivery to your HTTPS endpoints
    name: Webhooks
  - description: Cursor based event feed
    name: Events
  - description: Prints used this period
    name: Usage
paths:
  /v1/webhooks/{id}:
    get:
      tags:
        - Webhooks
      summary: Get a webhook endpoint
      description: >-
        Returns one endpoint, including whether it is enabled and why it was
        disabled.
      operationId: getWebhook
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
          description: The endpoint
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid API key or session
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The key scope or member role does not allow this
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Not found in this organization and mode
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Rate limit or test mode cap reached; retry after the Retry-After
            header
      security:
        - ApiKeyAuth: []
        - BasicAuth: []
components:
  schemas:
    WebhookEndpoint:
      properties:
        createdAt:
          format: date-time
          type: string
        description:
          type:
            - string
            - 'null'
        disabledReason:
          description: >-
            Why the endpoint is disabled: by a user, or automatically after 5
            days of failures
          type:
            - string
            - 'null'
        enabled:
          type: boolean
        events:
          items:
            enum:
              - printjob.queued
              - printjob.sent
              - printjob.received
              - printjob.printing
              - printjob.done
              - printjob.error
              - printjob.cancelled
              - printjob.expired
              - computer.online
              - computer.offline
              - printer.added
              - printer.removed
              - printer.online
              - printer.offline
              - printer.updated
            example: printjob.done
            type: string
          type: array
        failingSince:
          description: Start of the current run of failed deliveries; null while healthy
          format: date-time
          type:
            - string
            - 'null'
        id:
          format: uuid
          type: string
        mode:
          enum:
            - live
            - test
          type: string
        url:
          example: https://example.com/printeasy/webhooks
          type: string
      required:
        - id
        - url
        - description
        - events
        - mode
        - enabled
        - disabledReason
        - failingSince
        - createdAt
      type: object
    Error:
      description: >-
        Every error response uses this envelope; code is stable, message is for
        humans.
      properties:
        error:
          properties:
            code:
              example: not_found
              type: string
            message:
              example: Printer not found
              type: string
            request_id:
              example: 4f9c2a7e-1b3d-4c5e-8f6a-0b1c2d3e4f5a
              type: string
          required:
            - code
            - message
            - request_id
          type: object
      required:
        - error
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: pe_live_ or pe_test_ key
      description: >-
        Send `Authorization: Bearer <API key>`. Use a pe_test_ key in the
        playground; it only reaches virtual test printers.
      scheme: bearer
      type: http
      x-default: pe_test_REPLACE_WITH_YOUR_TEST_KEY
    BasicAuth:
      description: >-
        PrintNode compatible: put the API key in the username with an empty
        password
      scheme: basic
      type: http

````

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