> ## 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.

# LIST - Webhook

>  This API allows authenticated users to retrieve their webhook configurations. It supports both listing all webhooks created by the user and retrieving a specific webhook by its unique identifier.


 **Key Notes:** 
 - Returns only webhooks created by the authenticated user. 
 - Supports pagination for the list endpoint. 
 - Individual webhook retrieval requires the webhook's unique ID.


 **Endpoints:** 
 - **List Webhooks**: `GET /webhooks/v1/webhook/` - Returns paginated list of user's webhooks 
 - **Get Specific Webhook**: `GET /webhooks/v1/webhook/{id}/` - Returns details of a specific webhook


 **Scenario: Managing Webhook Configurations** 
 - A developer wants to review all their configured webhooks. 
 - They call the list endpoint to see all webhooks they've created. 
 - They can then use specific webhook IDs to get detailed information about individual webhooks. 
 - This is useful for monitoring webhook status and updating configurations. 



## OpenAPI

````yaml GET /webhooks/v1/webhook/
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/:
    get:
      tags:
        - Webhooks
      summary: List Webhooks
      description: >-
        Retrieves a paginated list of webhooks created by the authenticated
        user. Results are ordered by creation date (newest first).
      operationId: listWebhooks
      responses:
        '200':
          description: List of webhooks retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookListResponse'
              example:
                - id: 3796d065-684a-4016-8854-a9bc78c1038c
                  api_template:
                    id: 2820c61f-64f8-4a24-9276-6ef855864772
                    name: worksheet_generation
                    display_name: Worksheet Generation
                    description: null
                  endpoint_url: https://example.com/webhook/worksheet-generation
                - id: bb7fa98d-f033-49df-80c0-a3898fa85684
                  api_template:
                    id: 0e92e879-64de-419f-acf2-bec230bd9e35
                    name: worksheet_question_configuration
                    display_name: Worksheet Question Configuration
                    description: null
                  endpoint_url: https://example.com/webhook/worksheet-question-config
                - id: 03ad3dcf-9c2f-4461-a287-5cfda1ded791
                  api_template:
                    id: 9920460f-3011-49e7-9e10-65ae275d0486
                    name: worksheet_initialize_metadata
                    display_name: Worksheet Initialize Metadata
                    description: null
                  endpoint_url: https://example.com/webhook/worksheet-metadata
                - id: 9f76036d-bb5c-4cf3-9495-668793869028
                  api_template:
                    id: e8c2b77e-306a-4b94-8b4f-e80d8af6f721
                    name: lesson_plan_finalize_metadata
                    display_name: Lesson Plan Finalize Metadata
                    description: null
                  endpoint_url: https://example.com/webhook/lesson-plan-finalize
                - id: 7b622a8c-c7ca-43f1-9c9e-01e3bf4f7581
                  api_template:
                    id: 4b8d43f7-80c8-4b20-92bb-dbe19f42272e
                    name: lesson_plan_initialize_metadata
                    display_name: Lesson Plan Initalize Metadata
                    description: null
                  endpoint_url: https://example.com/webhook/lesson-plan-metadata
                - 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
                - id: 93a9b83e-0f63-444f-b604-4912d7a0d93f
                  api_template:
                    id: 0d345d9d-3609-40ea-8349-ccafa6a4bdf5
                    name: assignment_evaluation_model_answer_extraction
                    display_name: Assignment Model Answer Extraction
                    description: null
                  endpoint_url: https://example.com/webhook/assignment-model-answer
                - id: 1935f688-2e84-4404-967d-f1d98fc9c1a6
                  api_template:
                    id: a61981c1-7bb5-4107-939c-dffe368dcaec
                    name: assignment_evaluation_question_paper_extraction
                    display_name: Assignment Question Extraction
                    description: null
                  endpoint_url: https://example.com/webhook/assignment-question
                - id: 46efed00-9e8f-490b-a00d-b93335cf4c01
                  api_template:
                    id: ff4be808-b444-49b8-b7f3-9b78258e03b7
                    name: exam_evaluation_student_answer_sheet_extraction
                    display_name: Exam Evaluation Answer Sheet Extraction
                    description: null
                  endpoint_url: https://example.com/webhook/exam-answer-sheet
                - id: 7d0b95a1-fc79-4127-a823-9a823f2ced9b
                  api_template:
                    id: 2086148b-6d1a-452a-857e-0e297f7ba950
                    name: exam_evaluation_model_answer_extraction
                    display_name: Exam Evaluation Model Answer Extraction
                    description: null
                  endpoint_url: https://example.com/webhook/exam-model-answer
                - id: 1b0e6f59-5ee7-42de-a103-fa12f680da9d
                  api_template:
                    id: d3f0f2aa-7788-4437-b5ab-d838535ee1ff
                    name: exam_evaluation_question_paper_extraction
                    display_name: Exam Evaluation Question Extraction
                    description: null
                  endpoint_url: https://example.com/webhook/exam-question
        '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.
        '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:
    WebhookListResponse:
      type: array
      items:
        $ref: '#/components/schemas/WebhookResponse'
      description: List of webhooks created by the authenticated user
    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
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````