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.

GET

webhooks

webhook-api-templates

Get Webhook Templates

curl --request GET \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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": ""
  }
]

{
  "error": {
    "code": 401,
    "message": {
      "non_field_errors": [
        "Authentication credentials were not provided."
      ]
    }
  }
}

{
  "error": {
    "code": 500,
    "message": {
      "non_field_errors": [
        "Internal Server Error"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

List of webhook templates retrieved successfully.

string<uuid>

required

Unique identifier of the webhook template

Example:

"488f4644-057d-41e7-9a74-72c040602647"

name

string

required

Internal name/identifier for the webhook template

Example:

"assignment_answer_sheet_extraction"

display_name

string

required

Human-readable display name for the webhook template

Example:

"Assignment Answer Sheet Extraction"

description

string

required

Detailed description of what this webhook template does

Example:

""

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.

Get Webhook Templates

curl --request GET \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.crazygoldfish.com/webhooks/v1/webhook-api-templates/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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": ""
  }
]

{
  "error": {
    "code": 401,
    "message": {
      "non_field_errors": [
        "Authentication credentials were not provided."
      ]
    }
  }
}

{
  "error": {
    "code": 500,
    "message": {
      "non_field_errors": [
        "Internal Server Error"
      ]
    }
  }
}

Overview

Authentication

K12

Assignment Rubrics

Meta Data

Lesson Plan

Worksheet Generation

Action Plans

Webhook

Classroom Observation

Standardized Language Exams

GET - Webhook Template

Authorizations

Response