Hooks

Example Callback Triggered

This endpoint demonstrates the structure of a callback triggered when a specified traffic threshold is reached.
The callback URL should be provided during webhook setup, and this request will be made when the traffic trigger value is reached.

post/example/callback

Request

Base URL
https://your-callback-url.com
Auth
none required
TypeScript
https://skmtc.dev/edisglobal/apis/edis-global-management-api/docs/example/callback/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

kvmstring

The unique identifier of the KVM VPS.

detailsstring

Details about the traffic threshold reached.

trigger_valueinteger

The current traffic value when the callback is triggered.

Example request

{
  "kvm": "kvm_123456_789012",
  "details": "Traffic usage reached 80%",
  "trigger_value": 80
}

Response

Callback received and processed successfully.

statusstring

Status of the callback handling.

messagestring

Confirmation message indicating successful processing.

Example response

{
  "status": "success",
  "message": "Callback received successfully."
}

Changes

No recorded changes to this operation across all 1 revision of this API.