> ## 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 Template > This API allows authenticated users to retrieve a paginated list of available webhook templates that can be used for various extraction and processing tasks. **Key Notes:** - Returns a list of webhook templates with their unique identifiers, names, display names, and descriptions. - Templates include various processing types for exam evaluation, assignment evaluation, lesson plans, worksheets, and action plans. - Each template has a unique ID that can be used for webhook configuration and setup. **Available Template Types:** - **Exam Evaluation Question Extraction**: For extracting questions from exam documents - **Exam Evaluation Model Answer Extraction**: For extracting model answers from exams - **Exam Evaluation Answer Sheet Evaluation**: For processing student answer sheets from exams - **Assignment Question Extraction**: For extracting questions from assignment documents - **Assignment Model Answer Extraction**: For extracting model answers from assignments - **Assignment Answer Sheet Evaluation**: For processing student answer sheets from assignments - **Lesson Plan Initialize Metadata**: For initializing metadata for lesson plan creation - **Lesson Plan Finalize Metadata**: For finalizing metadata in lesson plans - **Lesson Plan Instructional Framework Builder**: For building instructional frameworks in lesson plans - **Lesson Plan Additional Enrichment Block**: For adding enrichment blocks to lesson plans - **Worksheet Initialize Metadata**: For initializing metadata for worksheet generation - **Worksheet Question Configuration**: For configuring questions in worksheets - **Worksheet Generation**: For generating complete worksheets - **Teacher Action Plan**: For processing teacher action plan requests - **Student Action Plan**: For processing student action plan requests **Scenario: Setting Up Webhook Integration** - A developer wants to integrate webhook functionality for automatic processing of uploaded documents. - They call this endpoint to get the list of available webhook templates. - They can then use the template IDs to configure webhooks for specific extraction tasks. ## OpenAPI ````yaml GET /webhooks/v1/webhook-api-templates/ openapi: 3.0.1 info: title: Webhook Template API description: >- An API for retrieving available webhook templates for various extraction and processing tasks. 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-api-templates/: get: tags: - Webhook Templates summary: Get Webhook Templates description: >- Retrieves a paginated list of available webhook templates that can be used for various extraction and processing tasks. Templates include assignment answer sheet extraction, model answer extraction, question extraction, and K12-specific variants. operationId: getWebhookTemplates responses: '200': description: List of webhook templates retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/WebhookTemplateListResponse' example: - id: dd137bbe-2d85-41eb-b7bc-f638ecdd5466 name: student_action_plan display_name: Student Action Plan description: null - id: ab4dde3d-20ad-4e1b-8369-523bed24e0b3 name: teacher_action_plan display_name: Teacher Action Plan description: null - id: 2820c61f-64f8-4a24-9276-6ef855864772 name: worksheet_generation display_name: Worksheet Generation description: null - id: 0e92e879-64de-419f-acf2-bec230bd9e35 name: worksheet_question_configuration display_name: Worksheet Question Configuration description: null - id: 9920460f-3011-49e7-9e10-65ae275d0486 name: worksheet_initialize_metadata display_name: Worksheet Initialize Metadata description: null - id: 763705a3-bad7-475e-9be4-75b96baf1854 name: lesson_plan_additional_enrichment_blocks display_name: Lesson Plan Additional Enrichment Block description: null - id: f97f77b1-a0dc-4c89-8964-72c44f71bdb7 name: lesson_plan_instructional_framework_builder display_name: Lesson Plan Instructional Framework Builder description: null - id: e8c2b77e-306a-4b94-8b4f-e80d8af6f721 name: lesson_plan_finalize_metadata display_name: Lesson Plan Finalize Metadata description: null - id: 4b8d43f7-80c8-4b20-92bb-dbe19f42272e name: lesson_plan_initialize_metadata display_name: Lesson Plan Initalize Metadata description: null - id: 488f4644-057d-41e7-9a74-72c040602647 name: assignment_evaluation_student_answer_sheet_extraction display_name: Assignment Answer Sheet Extraction description: '' - id: 0d345d9d-3609-40ea-8349-ccafa6a4bdf5 name: assignment_evaluation_model_answer_extraction display_name: Assignment Model Answer Extraction description: '' - id: a61981c1-7bb5-4107-939c-dffe368dcaec name: assignment_evaluation_question_paper_extraction display_name: Assignment Question Extraction description: '' - id: ff4be808-b444-49b8-b7f3-9b78258e03b7 name: exam_evaluation_student_answer_sheet_extraction display_name: Exam Evaluation Answer Sheet Extraction description: '' - id: 2086148b-6d1a-452a-857e-0e297f7ba950 name: exam_evaluation_model_answer_extraction display_name: Exam Evaluation Model Answer Extraction description: '' - id: d3f0f2aa-7788-4437-b5ab-d838535ee1ff name: exam_evaluation_question_paper_extraction display_name: Exam Evaluation Question Extraction description: '' '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: WebhookTemplateListResponse: type: array items: $ref: '#/components/schemas/WebhookTemplate' description: List of available webhook templates 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: - WebhookAPI not found required: - non_field_errors required: - code - message required: - error WebhookTemplate: type: object properties: id: type: string format: uuid description: Unique identifier of the webhook template example: 488f4644-057d-41e7-9a74-72c040602647 name: type: string description: Internal name/identifier for the webhook template example: assignment_answer_sheet_extraction display_name: type: string description: Human-readable display name for the webhook template example: Assignment Answer Sheet Extraction description: type: string description: Detailed description of what this webhook template does example: '' required: - id - name - display_name - description securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````