POST
/
kvm
/
v2
/
hooks
/
set
curl --request POST \
  --url https://{api_host}.edisglobal.com/kvm/v2/hooks/set \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data signature=session_signature_12345 \
  --data kvm_id=kvm_123456_789012 \
  --data valid_until=2025-01-12T15:30:00Z \
  --data callback_method=post \
  --data callback_user=callback_user \
  --data callback_pw=callback_password \
  --data type=traffic \
  --data trigger_value=80 \
  --data callback_url=https://example.com/yourcallback
{
  "status": "success",
  "hook_id": "123"
}

Body

application/x-www-form-urlencoded
Required parameters to set a webhook for traffic monitoring. All parameters must be passed in the request body as `application/x-www-form-urlencoded`.
​
signature
string

The session signature obtained from the "Create AUTH-session" call.

Example:

"session_signature_12345"

​
kvm_id
string

The unique identifier of the KVM VPS.

Example:

"kvm_123456_789012"

​
valid_until
string

The expiration timestamp for the session, as obtained from the "Create AUTH-session" call.

Example:

"2025-01-12T15:30:00Z"

​
callback_method
string

The HTTP method to use for the callback (post or get).

Example:

"post"

​
callback_user
string

(Optional) Username for callback authentication.

Example:

"callback_user"

​
callback_pw
string

(Optional) Password for callback authentication.

Example:

"callback_password"

​
type
string

Type of hook to create (only traffic is allowed).

Example:

"traffic"

​
trigger_value
string

Trigger value to activate the webhook.

  • A percentage value for traffic usage (e.g., 80 for 80%).
  • Set to demo for immediate unique call.
Example:

"80"

​
callback_url
string

The callback URL (HTTP or HTTPS) that receives notifications
when the trigger value is reached.
Example: https://example.com/yourcallback.
Source IP: 149.154.154.251

Example:

"https://example.com/yourcallback"

Response

200
application/json
Webhook set successfully.
​
status
string

The status of the operation.

Example:

"success"

​
hook_id
string

The ID of the created webhook.

Example:

"123"

Was this page helpful?