PATCH - Webhook

This API allows authenticated users to update an existing webhook configuration. Only the endpoint URL and secret hash can be modified - the API template and other core settings remain unchanged.

Key Notes:

Requires authentication and ownership of the webhook (created by the authenticated user).
Only endpoint_url and secret_hash fields can be updated.
The API template ID cannot be changed after webhook creation.
Returns the updated webhook details after successful modification.

Updatable Fields:

endpoint_url: The URL where webhook notifications will be sent (required)
secret_hash: Optional secret key for webhook authentication (will be encrypted)

Non-Updatable Fields:

api_template: Cannot be changed after webhook creation
status: Managed separately by the system
created_by: Immutable field

Scenario: Updating Webhook Configuration

A developer needs to change their webhook endpoint URL due to server migration.
They call this endpoint with the webhook ID and new endpoint URL.
They can also update the secret hash if they want to change authentication.
The system updates the webhook and returns the modified configuration.
This is useful for maintaining webhook functionality during infrastructure changes.

PATCH

webhooks

webhook

{id}

Update Webhook

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint_url": "https://new-example.com/webhook/assignment-processing",
  "secret_hash": "new-secret-key-456"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/"

payload = {
    "endpoint_url": "https://new-example.com/webhook/assignment-processing",
    "secret_hash": "new-secret-key-456"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    endpoint_url: 'https://new-example.com/webhook/assignment-processing',
    secret_hash: 'new-secret-key-456'
  })
};

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/', 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/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'endpoint_url' => 'https://new-example.com/webhook/assignment-processing',
    'secret_hash' => 'new-secret-key-456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/"

	payload := strings.NewReader("{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}"

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

{
  "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://new-example.com/webhook/assignment-answer-sheet"
}

{
  "error": {
    "code": 400,
    "message": {
      "endpoint_url": [
        "This field is required."
      ]
    }
  }
}

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

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Webhook not found"
      ]
    }
  }
}

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

Path Parameters

string<uuid>

required

Unique identifier of the webhook to update.

Body

application/json

endpoint_url

string<uri>

required

The URL where webhook notifications will be sent

Example:

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

secret_hash

string

Optional secret key for webhook authentication (will be encrypted)

Example:

"my-secret-key-123"

Response

Webhook updated 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 - Class Track Analysis This API enables authenticated users to **submit class-level audio recordings** for comprehensive AI-powered analysis and evaluation using CrazyGoldFish AI technology. The endpoint performs thorough validation of audio links, securely stores educational metadata, and initiates a processing workflow for transcript generation and rubric-based AI evaluation. For metadata ID references, please consult the [Metadata API Documentation](https://docs.crazygoldfish.com/api-reference/endpoint/metadata/boards). **Key Capabilities:** - **Secure Audio Validation**: Accepts only publicly accessible HTTPS URLs pointing to .mp3 audio files - **Comprehensive Metadata Management**: Captures and stores institutional, teacher, board, grade, subject, and rubric information - **Flexible Rubric Integration**: Supports both UUID and integer-based rubric identifier formats **Typical Use Case: Submitting a Classroom Recording for AI Analysis** - An educator uploads a classroom recording to a public cloud storage service and obtains a secure HTTPS URL - The teacher submits the audio URL along with comprehensive class metadata including board, grade, subject, and rubric details - The system performs rigorous validation of both URL format and metadata completeness before initiating processing - Upon successful validation, the system returns a unique analysis identifier for tracking the evaluation progress <Warning> Only publicly accessible HTTPS URLs ending with .mp3 file extensions are accepted. Private URLs, non-HTTPS links, or unsupported file formats will result in validation errors and request rejection. </Warning>

Update Webhook

curl --request PATCH \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint_url": "https://new-example.com/webhook/assignment-processing",
  "secret_hash": "new-secret-key-456"
}
'

import requests

url = "https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/"

payload = {
    "endpoint_url": "https://new-example.com/webhook/assignment-processing",
    "secret_hash": "new-secret-key-456"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    endpoint_url: 'https://new-example.com/webhook/assignment-processing',
    secret_hash: 'new-secret-key-456'
  })
};

fetch('https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/', 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/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'endpoint_url' => 'https://new-example.com/webhook/assignment-processing',
    'secret_hash' => 'new-secret-key-456'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/"

	payload := strings.NewReader("{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api-staging.crazygoldfish.com/webhooks/v1/webhook/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"endpoint_url\": \"https://new-example.com/webhook/assignment-processing\",\n  \"secret_hash\": \"new-secret-key-456\"\n}"

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

{
  "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://new-example.com/webhook/assignment-answer-sheet"
}

{
  "error": {
    "code": 400,
    "message": {
      "endpoint_url": [
        "This field is required."
      ]
    }
  }
}

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

{
  "error": {
    "code": 404,
    "message": {
      "non_field_errors": [
        "Webhook not found"
      ]
    }
  }
}

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

PATCH - Webhook

Authorizations

Path Parameters

Body

Response