POST - Webhook

This API allows authenticated users to create a new webhook for automatic processing of uploaded documents. The webhook will be triggered when documents are processed using the specified API template.

Key Notes:

Requires authentication and a valid API template ID from the webhook templates endpoint.
The secret_hash field is encrypted using encryption for security.
Each user can only create one webhook per API template (duplicate prevention).
Returns the created webhook details including the generated UUID.

Required Fields:

api_template: UUID of the webhook template (from webhook templates endpoint)
endpoint_url: The URL where webhook notifications will be sent
secret_hash: Optional secret key for webhook authentication (will be encrypted)

Scenario: Setting Up Document Processing Webhook

A developer wants to receive automatic notifications when assignment answer sheets are processed.
They first call the webhook templates endpoint to get the template ID for ‘assignment_answer_sheet_extraction’.
They then call this endpoint with the template ID, their webhook URL, and optional secret hash.
The system creates the webhook and returns the webhook details for future reference.

POST

webhooks

webhook

Create Webhook

curl --request POST \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_template": "488f4644-057d-41e7-9a74-72c040602647",
  "endpoint_url": "https://example.com/webhook/assignment-processing",
  "secret_hash": "my-secret-key-123"
}
'

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

Authorizations

Authorization

string

header

required

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

Body

application/json

api_template

string<uuid>

required

UUID of the webhook template to use for processing

Example:

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

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

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.

Create Webhook

curl --request POST \
  --url https://api-staging.crazygoldfish.com/webhooks/v1/webhook/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_template": "488f4644-057d-41e7-9a74-72c040602647",
  "endpoint_url": "https://example.com/webhook/assignment-processing",
  "secret_hash": "my-secret-key-123"
}
'

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