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

webhooks

webhook

List Webhooks

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

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

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook/', 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/",
  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/"

	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/")

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

{
  "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 webhooks retrieved successfully.

string<uuid>

required

Unique identifier of the webhook

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

api_template

object

required

Webhook template details

Show child attributes

endpoint_url

string<uri>

required

The URL where webhook notifications are sent

Example:

"https://example.com/webhook/assignment-processing"

POST - Webhook This API allows authenticated users to create a new webhook for automatic processing of uploaded documents. The webhook will be triggered when documents are processed using the specified API template. **Key Notes:** - Requires authentication and a valid API template ID from the webhook templates endpoint. - The `secret_hash` field is encrypted using encryption for security. - Each user can only create one webhook per API template (duplicate prevention). - Returns the created webhook details including the generated UUID. **Required Fields:** - **api_template**: UUID of the webhook template (from webhook templates endpoint) - **endpoint_url**: The URL where webhook notifications will be sent - **secret_hash**: Optional secret key for webhook authentication (will be encrypted) **Scenario: Setting Up Document Processing Webhook** - A developer wants to receive automatic notifications when assignment answer sheets are processed. - They first call the webhook templates endpoint to get the template ID for 'assignment_answer_sheet_extraction'. - They then call this endpoint with the template ID, their webhook URL, and optional secret hash. - The system creates the webhook and returns the webhook details for future reference.

List Webhooks

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

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

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook/', 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/",
  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/"

	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/")

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

{
  "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

LIST - Webhook

Authorizations

Response