GET - Webhook

This API allows authenticated users to retrieve a specific webhook by its unique identifier. Only webhooks created by the authenticated user can be accessed, ensuring proper data isolation and security.

Key Notes:

Requires authentication and ownership verification (webhook must be created by the authenticated user).
Returns complete webhook details including configuration and metadata.
The webhook ID must be a valid UUID format.
Returns 404 if webhook doesn’t exist or user doesn’t have access to it.

Path Parameters:

id (required): Unique identifier of the webhook (UUID format)

Scenario: Retrieving Webhook Details

A developer wants to check the configuration of a specific webhook they created.
They call this endpoint with the webhook’s UUID.
The system verifies ownership and returns the webhook details.
This is useful for debugging webhook issues or verifying configuration before updates.

GET

webhooks

webhook

{id}

Get Webhook by ID

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

import requests

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

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/{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 => "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/{id}/"

	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/{id}/")

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

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

Response

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

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.

Get Webhook by ID

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

import requests

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

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/{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 => "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/{id}/"

	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/{id}/")

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

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

GET - Webhook

Authorizations

Path Parameters

Response