List webhook event templates

GET

webhooks

webhook-api-templates

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

import requests

url = "https://api.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.crazygoldfish.com/webhooks/v1/webhook-api-templates/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "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_evaluation",
    "display_name": "Assignment Answer Sheet Evaluation",
    "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_evaluation",
    "display_name": "Exam Evaluation Answer Sheet Evaluation",
    "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": ""
  }
]

Start here. Each row is one event, and its id is what you send as api_template in Register a webhook. For what each event means, when it fires, and what its delivery body looks like, see Async jobs and webhooks.

The response is a bare JSON array, not a paginated object. There is no count or data wrapper, and no page parameter.

description is an empty string or null on every template. Use name to tell events apart. Every account sees the same list of events.

Do not hardcode template IDs. The id values in the example response are illustrative. A template’s id is not a fixed value, so the ID for the same event name can differ from one CrazyGoldFish environment to another. Call this endpoint, find the row whose name matches the event you want, and use that row’s id.

There is no endpoint for fetching a single template. Read the one you want out of this list. There is also no template for worksheet_explanation_generation, so you cannot register a webhook for worksheet explanations. Poll for that result instead.

Next step

Register a webhook

Send a template id and your HTTPS address to start receiving that event.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Response

Every available event template, as a bare array. The id values below are illustrative only: read the real ones from this call, and match an event by its name.

string<uuid>

Template ID. Send it as api_template in Register a webhook.

Example:

"ff4be808-b444-49b8-b7f3-9b78258e03b7"

name

string

Machine name of the event. It arrives in the delivery body as name or webhook_name. See Async jobs and webhooks.

Example:

"exam_evaluation_student_answer_sheet_evaluation"

display_name

string

Human-readable name of the event.

Example:

"Exam Evaluation Answer Sheet Evaluation"

description

string | null

Currently an empty string or null for every template. Use name to tell events apart.

Example:

""

List webhook event templates

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

import requests

url = "https://api.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.crazygoldfish.com/webhooks/v1/webhook-api-templates/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "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_evaluation",
    "display_name": "Assignment Answer Sheet Evaluation",
    "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_evaluation",
    "display_name": "Exam Evaluation Answer Sheet Evaluation",
    "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": ""
  }
]

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

List webhook event templates

Next step

Register a webhook

Authorizations

Response

​Next step

Register a webhook

Authorizations

Response

Next step