List Deliveries

GET

webhooks

deliveries

List Deliveries

curl --request GET \
  --url https://api.hedra.com/v3/webhooks/deliveries \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hedra.com/v3/webhooks/deliveries', 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.hedra.com/v3/webhooks/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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://api.hedra.com/v3/webhooks/deliveries"

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

	req.Header.Add("Authorization", "<api-key>")

	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.hedra.com/v3/webhooks/deliveries")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "data": [
    {
      "job_id": "<string>",
      "job_accessible": true,
      "model": "<string>",
      "attempts": 123,
      "webhook_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "redelivery_count": 0,
      "redeliveries": [],
      "last_response_status": 123,
      "last_error": {
        "message": "<string>",
        "retryable": false,
        "retry_after": 123,
        "param": "<string>",
        "details": [
          {
            "field": "<string>",
            "message": "<string>",
            "reason": "<string>",
            "allowed": [
              "<string>"
            ]
          }
        ],
        "replaced_by": "<string>"
      },
      "last_attempt_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization

string

header

required

Primary scheme: Authorization: Key <key_id>:<secret>.

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

cursor

string | null

Response

Successful Response

data

WebhookDeliverySummary · object[]

required

Show child attributes

next_cursor

string | null

required

Opaque cursor for the next page, or null when this response completes the list. Always present. Endpoints that serve the whole collection at once always return null.

RedeliverReplay a finished delivery: reset it to PENDING and re-fire the signed POST. 404 if the delivery isn't visible to the caller; 409 if a delivery for the request is still in flight (a replay must not stack on it). The delivery is re-validated (SSRF) and re-signed at send time, and the receiver dedupes on ``X-Hedra-Webhook-Id``, so a replay is safe. The webhook id is stable across the original and every replay, because it identifies the event. Every attempt of a replayed cycle therefore also carries ``X-Hedra-Webhook-Redelivery: true`` — without it a receiver doing exactly what our guidance says (dedupe on the id) would silently discard the replay, which is the one case where the duplicate is the point.

⌘I

List Deliveries

curl --request GET \
  --url https://api.hedra.com/v3/webhooks/deliveries \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hedra.com/v3/webhooks/deliveries', 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.hedra.com/v3/webhooks/deliveries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$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://api.hedra.com/v3/webhooks/deliveries"

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

	req.Header.Add("Authorization", "<api-key>")

	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.hedra.com/v3/webhooks/deliveries")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "data": [
    {
      "job_id": "<string>",
      "job_accessible": true,
      "model": "<string>",
      "attempts": 123,
      "webhook_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "redelivery_count": 0,
      "redeliveries": [],
      "last_response_status": 123,
      "last_error": {
        "message": "<string>",
        "retryable": false,
        "retry_after": 123,
        "param": "<string>",
        "details": [
          {
            "field": "<string>",
            "message": "<string>",
            "reason": "<string>",
            "allowed": [
              "<string>"
            ]
          }
        ],
        "replaced_by": "<string>"
      },
      "last_attempt_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}