Send Webhook Test Event

Fire a canned test event at one of the caller’s webhooks to verify end-to-end delivery without persisting a notification record.

POST /api/v0/webhooks/{id}/test/

Send Webhook Test Event

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/webhooks/{id}/test/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.vast.ai/api/v0/webhooks/{id}/test/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.vast.ai/api/v0/webhooks/{id}/test/', 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://console.vast.ai/api/v0/webhooks/{id}/test/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://console.vast.ai/api/v0/webhooks/{id}/test/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.vast.ai/api/v0/webhooks/{id}/test/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/webhooks/{id}/test/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "success": true,
  "webhook_id": 42,
  "event_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

Unique identifier of the webhook to send a test event to.

Response

200

application/json

Success; returns {success: true, webhook_id: int, event_id: string}

success · boolean

Always true on success.

webhook_id · integer

ID of the webhook that received the test event.

event_id · string

Unique hex event identifier used in the delivered payload.