Configure Webhook

POST

api

webhooks

configure

Configure Webhook

curl --request POST \
  --url https://api.example.com/api/v1/webhooks/configure \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/webhooks/configure"

payload = { "url": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>'})
};

fetch('https://api.example.com/api/v1/webhooks/configure', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/webhooks/configure",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/webhooks/configure"

	payload := strings.NewReader("{\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/webhooks/configure")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "webhook_url": "<string>",
  "webhook_secret": "<string>"
}

Sets the account’s webhook URL. There is one URL per account, and both events go to it.

An API key cannot call this. Changing the webhook URL — or reading the signing secret — requires a session you opened yourself on the website. With an API key the request is rejected:

Response

{
  "detail": {
    "error": {
      "code": "FORBIDDEN_SESSION_TYPE",
      "message": "This action is not available for this session type"
    }
  }
}

A stolen key would otherwise be enough to point your events at someone else’s server. Set the URL in Dashboard → API instead; the same page shows the signing secret.

Request body

string

required

Webhook URL. HTTPS only on this endpoint, and it must not point at localhost, 127.0.0.1, 0.0.0.0 or ::1. Deliveries are additionally refused at send time to any host that resolves to a private, loopback or link-local address.

Response

string

The URL now configured.

string

The signing secret for X-Webhook-Signature. Generated the first time a URL is set on the account and stable afterwards.

Response

{
  "webhook_url": "https://yourserver.com/webhook/tronrental",
  "webhook_secret": "3f2a9c...64 hex characters..."
}

The dashboard door

The dashboard uses a second pair of endpoints on the same account-level fields — GET /api/v1/account/webhook to read the URL and secret, and PATCH /api/v1/account/webhook to set or clear them. They accept the same values with two differences: PATCH also allows an http:// URL, and sending {"webhook_url": null} clears the webhook. Clearing the URL keeps the secret, so re-enabling the webhook later does not invalidate the verification code you already deployed. Both endpoints require a website session as well.

Configure Webhook

curl --request POST \
  --url https://api.example.com/api/v1/webhooks/configure \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'

import requests

url = "https://api.example.com/api/v1/webhooks/configure"

payload = { "url": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>'})
};

fetch('https://api.example.com/api/v1/webhooks/configure', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/webhooks/configure",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/webhooks/configure"

	payload := strings.NewReader("{\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/webhooks/configure")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "webhook_url": "<string>",
  "webhook_secret": "<string>"
}

Core API

Bandwidth Rentals

Auto Refill

Orders

Invoices

Smart Mode

Transfer Packages

Account

Webhooks

Configure Webhook