Webhooks**

Register a Webhook Callback URL

POST /webhooks

Body

Name	Type	Description
callback_url	string	URL to receive event notifications
secret_key	string	Used to sign and validate callbacks
event	string (enum)	See supported events

Response

200

{
  "status": "success",
  "webhook_id": string,  // Unique ID for the webhook registration
  "callback_url": string,
  "secret_key": string,
  "event": string
}

422

Delete a Webhook Callback URL

DELETE /webhooks/{webhook_id}

Delete webhook based on webhook ID

Body

The request body should be empty

Response

200

{
  "status": "success",
  "webhook_id": string  // Unique ID for the deleted webhook
}

422

List Webhooks

GET /webhooks/

Returns a list of all registered webhooks

Body

The request body should be empty

Response

200

{
    "status": "success",
    "webhooks": [
        {
            "webhook_id": string,
            "callback_url": url,
            "secret_key": string,
            "event": string
        },
        ...
    ],
    "next_token": string
}

Get Webhook Detail by ID

GET /webhooks/{webhook_id}

Return webhook detail based on webhook ID

Body

The request body should be empty

Response

200

{
    "status": "success",
    "webhook_id": string,
    "callback_url": url,
    "secret_key": string,
    "event": string
}

422

Update Webhook by ID

PUT /webhooks/{webhook_id}

Update webhook detail based on webhook ID

Body

Name	Type	Description
callback_url	string	URL to receive event
secret_key	string	Used to sign and validate callbacks
event	string(enum)	See supported events

Response

200

{
  "status": "success",
  "webhook_id": string,  // Unique ID for the webhook registration
  "callback_url": string,
  "secret_key": string,
  "event": string
}

422

Invoke Webhook

POST /webhooks/{webhook_id}/invoke

Invoke webhook

Query Parameters

Name	Type	Description
request_id	string	Request ID

Body

The request body should be in json format

Response

200

{
    "status": "success"
}

422