GET
/
webhooks
/
v1
/
webhook
/
List Webhooks
curl --request GET \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "api_template": "488f4644-057d-41e7-9a74-72c040602647",
    "endpoint_url": "https://example.com/webhook/assignment-processing",
    "status": "enabled",
    "created_at": "2024-01-15T10:30:00Z",
    "created_by": "user123"
  },
  {
    "id": "b2c3d4e5-f6g7-8901-bcde-f23456789012",
    "api_template": "0d345d9d-3609-40ea-8349-ccafa6a4bdf5",
    "endpoint_url": "https://example.com/webhook/model-answer-processing",
    "status": "enabled",
    "created_at": "2024-01-14T15:45:00Z",
    "created_by": "user123"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

List of webhooks retrieved successfully.

List of webhooks created by the authenticated user

​
id
string<uuid>
required

Unique identifier of the webhook

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
api_template
string<uuid>
required

UUID of the webhook template used

Example:

"488f4644-057d-41e7-9a74-72c040602647"

​
endpoint_url
string<uri>
required

The URL where webhook notifications are sent

Example:

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

​
status
enum<string>
required

Current status of the webhook

Available options:
enabled,
disabled
Example:

"enabled"

​
created_at
string<date-time>
required

Timestamp when the webhook was created

Example:

"2024-01-15T10:30:00Z"

​
created_by
string
required

ID of the user who created the webhook

Example:

"user123"