Send a test event
POST/v1/webhooks/{webhookId}/test
Queues a webhook.test event for the endpoint, whatever event types it picked. It is signed, logged and retried like any other event. The endpoint must be enabled. An endpoint takes at most 30 test events and redeliveries an hour, and none while 100 of its deliveries are waiting (429 rate_limited).
Request
curl -s -X POST $BLITFRAME/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test \
-H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests
response = requests.post(
f"{os.environ['BLITFRAME']}/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test",
headers={"Authorization": f"Bearer {os.environ['BLITFRAME_API_KEY']}"},
)
print(response.json())
const response = await fetch(`${process.env.BLITFRAME}/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test`, {
method: "POST",
headers: { Authorization: `Bearer ${process.env.BLITFRAME_API_KEY}` },
});
console.log(await response.json());
<?php
$request = curl_init(getenv("BLITFRAME") . "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test");
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("BLITFRAME_API_KEY"),
],
]);
$response = curl_exec($request);
echo $response;
require "net/http"
uri = URI(ENV["BLITFRAME"] + '/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test')
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer " + ENV["BLITFRAME_API_KEY"]
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
puts response.body
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("POST", os.Getenv("BLITFRAME")+"/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test", nil)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+os.Getenv("BLITFRAME_API_KEY"))
response, err := http.DefaultClient.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
text, _ := io.ReadAll(response.Body)
fmt.Println(string(text))
}
using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post,
Environment.GetEnvironmentVariable("BLITFRAME") + "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("BLITFRAME_API_KEY"));
using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create(System.getenv("BLITFRAME") + "/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/test"))
.header("Authorization", "Bearer " + System.getenv("BLITFRAME_API_KEY"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
Path parameters
webhookIdstring (uuid)required
Headers
AuthorizationBearer Blitframe API keyrequiredAPI key from the developer console.
Responses
- 202 Accepted
application/json · WebhookDeliveryDto
idstring (uuid)messageIdstring (uuid)eventTypeWebhookEventTypeOne of
render.succeededrender.failedrender.cancelleddownload_archive.readydownload_archive.failedversion_export.readyversion_export.failedbalance.lowwebhook.teststatusWebhookDeliveryStatusOne of
pendingdeliveredfailedattemptsintegerlastStatusCodeinteger or nulllastErrorstring or nulllastResponsestring or nullcreatedAtstring (date-time)lastAttemptAtstring (date-time) or nullnextAttemptAtstring (date-time) or nulldeliveredAtstring (date-time) or null
Errors
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 409 Conflict
- 429 Too Many Requests
application/json · ErrorResponse
errorApiErrorApiError fields
codestringmessagestring
Errors lists the error codes and says when to retry.