Configurar webhook

POST

api

webhooks

configure

Configurar 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>"
}

Define a URL de webhook da conta. Há uma URL por conta, e ambos os eventos vão para ela.

Uma chave de API não pode chamar este endpoint. Mudar a URL do webhook — ou ler o segredo de assinatura — exige uma sessão aberta por você mesmo no site. Com uma chave de API a requisição é recusada:

Response

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

Caso contrário, uma chave roubada bastaria para apontar os seus eventos para o servidor de outra pessoa. Defina a URL em Dashboard → API; a mesma página mostra o segredo de assinatura.

Corpo da requisição

string

obrigatório

URL do webhook. Neste endpoint somente HTTPS, e ela não pode apontar para localhost, 127.0.0.1, 0.0.0.0 ou ::1. Além disso, a entrega é recusada no momento do envio para qualquer host que resolva para um endereço privado, loopback ou link-local.

Resposta

string

A URL agora configurada.

string

O segredo de assinatura para X-Webhook-Signature. Gerado na primeira vez que uma URL é definida na conta e estável depois disso.

Response

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

A porta do painel

O painel usa um segundo par de endpoints sobre os mesmos campos da conta — GET /api/v1/account/webhook para ler a URL e o segredo, e PATCH /api/v1/account/webhook para defini-los ou limpá-los. Aceitam os mesmos valores, com duas diferenças: o PATCH também aceita uma URL http://, e enviar {"webhook_url": null} limpa o webhook. Limpar a URL mantém o segredo, de modo que reativar o webhook mais tarde não invalida o código de verificação que você já publicou. Ambos os endpoints também exigem uma sessão do site.

Configurar 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>"
}

API Principal

Aluguéis de largura de banda

Recarga automática

Pedidos

Faturas

Smart Mode

Pacotes de transferência

Conta

Webhooks

Configurar webhook