List your webhooks

GET

webhooks

webhook

List your webhooks

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

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

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

[
  {
    "id": "c5a71f30-6b82-4d19-9e4a-8f0d3b6c2157",
    "api_template": {
      "id": "ff4be808-b444-49b8-b7f3-9b78258e03b7",
      "name": "exam_evaluation_student_answer_sheet_evaluation",
      "display_name": "Exam Evaluation Answer Sheet Evaluation",
      "description": ""
    },
    "endpoint_url": "https://example.com/webhooks/crazygoldfish"
  },
  {
    "id": "1e83b9c6-40af-4f27-b5d1-7a62e0c4839b",
    "api_template": {
      "id": "2820c61f-64f8-4a24-9276-6ef855864772",
      "name": "worksheet_generation",
      "display_name": "Worksheet Generation",
      "description": null
    },
    "endpoint_url": "https://example.com/webhooks/crazygoldfish/worksheets"
  }
]

Returns the webhooks registered by the same API user as your access token, newest first. Webhooks registered by other API users are never included, even inside the same account. Each item has the webhook id, the expanded api_template for its event, and the endpoint_url it posts to.

The response is a bare JSON array, not a paginated object. There is no count or data wrapper, and no page parameter. If you have no webhooks, you get [].

secret_hash is never returned by any webhook endpoint. Keep your own copy of each secret so your receiver can check incoming deliveries.

Next step

Get a webhook

Fetch one webhook by ID.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Response

Your webhooks, as a bare array. Empty if you have none.

string<uuid>

Unique ID of the webhook. Use it in Get a webhook and Update a webhook.

Example:

"c5a71f30-6b82-4d19-9e4a-8f0d3b6c2157"

api_template

object

The event this webhook listens for, expanded. It cannot be changed after registration.

Show child attributes

endpoint_url

string<uri>

The HTTPS address CrazyGoldFish posts the event to.

Example:

"https://example.com/webhooks/crazygoldfish"

List your webhooks

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

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

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

[
  {
    "id": "c5a71f30-6b82-4d19-9e4a-8f0d3b6c2157",
    "api_template": {
      "id": "ff4be808-b444-49b8-b7f3-9b78258e03b7",
      "name": "exam_evaluation_student_answer_sheet_evaluation",
      "display_name": "Exam Evaluation Answer Sheet Evaluation",
      "description": ""
    },
    "endpoint_url": "https://example.com/webhooks/crazygoldfish"
  },
  {
    "id": "1e83b9c6-40af-4f27-b5d1-7a62e0c4839b",
    "api_template": {
      "id": "2820c61f-64f8-4a24-9276-6ef855864772",
      "name": "worksheet_generation",
      "display_name": "Worksheet Generation",
      "description": null
    },
    "endpoint_url": "https://example.com/webhooks/crazygoldfish/worksheets"
  }
]

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Next step

Get a webhook

Authorizations

Response

​Next step

Get a webhook

Authorizations

Response

Next step