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

# GET - Webhook

>  This API allows authenticated users to retrieve a specific webhook by its unique identifier. Only webhooks created by the authenticated user can be accessed, ensuring proper data isolation and security.


 **Key Notes:** 
 - Requires authentication and ownership verification (webhook must be created by the authenticated user). 
 - Returns complete webhook details including configuration and metadata. 
 - The webhook ID must be a valid UUID format. 
 - Returns 404 if webhook doesn't exist or user doesn't have access to it.


 **Path Parameters:** 
 - **id** (required): Unique identifier of the webhook (UUID format)


 **Scenario: Retrieving Webhook Details** 
 - A developer wants to check the configuration of a specific webhook they created. 
 - They call this endpoint with the webhook's UUID. 
 - The system verifies ownership and returns the webhook details. 
 - This is useful for debugging webhook issues or verifying configuration before updates. 



## OpenAPI

````yaml GET /webhooks/v1/webhook/{id}/
openapi: 3.0.1
info:
  title: Webhook Management API
  description: >-
    An API for managing webhooks for automatic document processing and
    notifications.
  version: 1.0.0
servers:
  - url: https://api-staging.crazygoldfish.com
    description: SandBox endpoint
  - url: https://api.crazygoldfish.com
    description: Prod End Point
security: []
paths:
  /webhooks/v1/webhook/{id}/:
    get:
      tags:
        - Webhooks
      summary: Get Webhook by ID
      description: >-
        Retrieves a specific webhook by its unique identifier. Only returns
        webhooks created by the authenticated user.
      operationId: getWebhookById
      parameters:
        - name: id
          in: path
          description: Unique identifier of the webhook.
          required: true
          schema:
            type: string
            format: uuid
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
      responses:
        '200':
          description: Webhook retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookResponse'
              example:
                id: 428f1ea8-7efc-4ec8-a449-85b010b26472
                api_template:
                  id: 488f4644-057d-41e7-9a74-72c040602647
                  name: assignment_evaluation_student_answer_sheet_extraction
                  display_name: Assignment Answer Sheet Extraction
                  description: null
                endpoint_url: https://example.com/webhook/assignment-answer-sheet
        '401':
          description: Unauthorized - Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 401
                  message:
                    non_field_errors:
                      - Authentication credentials were not provided.
        '404':
          description: Not Found - Webhook not found or not owned by user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message:
                    non_field_errors:
                      - Webhook not found
        '500':
          description: Internal Server Error - Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message:
                    non_field_errors:
                      - Internal Server Error
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the webhook
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        api_template:
          type: object
          description: Webhook template details
          properties:
            id:
              type: string
              format: uuid
              description: UUID of the webhook template
              example: 488f4644-057d-41e7-9a74-72c040602647
            name:
              type: string
              description: Internal name of the webhook template
              example: assignment_evaluation_student_answer_sheet_extraction
            display_name:
              type: string
              description: Display name of the webhook template
              example: Assignment Answer Sheet Extraction
            description:
              type: string
              nullable: true
              description: Description of the webhook template
              example: null
          required:
            - id
            - name
            - display_name
        endpoint_url:
          type: string
          format: uri
          description: The URL where webhook notifications are sent
          example: https://example.com/webhook/assignment-processing
      required:
        - id
        - api_template
        - endpoint_url
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              description: HTTP status code
              example: 404
            message:
              type: object
              properties:
                non_field_errors:
                  type: array
                  items:
                    type: string
                  description: List of error messages
                  example:
                    - Webhook not found
              required:
                - non_field_errors
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````