Get a webhook

GET

webhooks

webhook

{id}

Get a webhook

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

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

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

Returns the webhook’s id, its expanded api_template, and its endpoint_url. This call only finds webhooks registered by the same API user as your access token. A webhook registered by another API user returns 404 with Webhook not found, the same answer as an ID that does not exist.

secret_hash is not in the response. No endpoint reads a stored secret back, so keep your own copy.

Next step

Update a webhook

Change the address or the secret.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

string<uuid>

required

Unique ID of the webhook, from Register a webhook or List your webhooks.

Response

The webhook.

A registered webhook. The secret is never returned by these endpoints.

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"

Get a webhook

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

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

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

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Next step

Update a webhook

Authorizations

Path Parameters

Response

​Next step

Update a webhook

Authorizations

Path Parameters

Response

Next step