API reference / Webhooks

Resend missed events

POST/v1/webhooks/{webhookId}/recover

Queues again, once each, the events in the delivery log that never reached the endpoint, logged at or after since (leave it out for the whole 30-day log). Each keeps its webhook-id. The endpoint must be enabled.

Request

curl -s -X POST $BLITFRAME/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/recover \
  -H "Authorization: Bearer $BLITFRAME_API_KEY"
import os, requests

response = requests.post(
    f"{os.environ['BLITFRAME']}/webhooks/ce9bfd3d-fceb-4655-8821-2e3f7ce0b101/recover",
    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/recover`, {
  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/recover");
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/recover')
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/recover", 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/recover");
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/recover"))
            .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 keyrequired

    API key from the developer console.

Body

application/json · optional · RecoverWebhookRequest or null

  • sincestring (date-time) or null

Try it

POST/v1/webhooks/{webhookId}/recover

Used for the requests you send from this page only. It is not saved.

This sends a real request to your workspace: a render spends render seconds, and a delete is final.

Response

Send the request to see the answer here.

Responses

  • 202 Accepted

application/json · WebhookRecoveryDto

  • queuedinteger

Errors

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 409 Conflict
  • 429 Too Many Requests

application/json · ErrorResponse

  • ApiError fields
    • codestring
    • messagestring

Errors lists the error codes and says when to retry.