Skip to main content
GET
/
webhook-deliveries
Get webhook deliveries
curl --request GET \
  --url https://api.royalti.io/webhook-deliveries \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.royalti.io/webhook-deliveries"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.royalti.io/webhook-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.royalti.io/webhook-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: 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://api.royalti.io/webhook-deliveries"

req, _ := http.NewRequest("GET", 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.get("https://api.royalti.io/webhook-deliveries")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/webhook-deliveries")

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

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

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "Webhook deliveries retrieved successfully",
  "data": {
    "webhookDeliveries": [
      {
        "id": "<string>",
        "eventType": "<string>",
        "requestUrl": "<string>",
        "requestMethod": "<string>",
        "responseStatus": 123,
        "responseTimeMs": 123,
        "attemptNumber": 123,
        "isRetry": true,
        "finalAttempt": true,
        "errorCode": "<string>",
        "errorMessage": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "event": {
          "id": "<string>",
          "eventType": "<string>",
          "payload": {},
          "createdAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "totalItems": 123,
    "totalPages": 123,
    "currentPage": 123
  }
}
{
"status": "error",
"message": "Invalid request parameters"
}
{
"status": "error",
"message": "Unauthorized"
}

Code Examples

const response = await fetch('https://api.royalti.io/webhook-deliveries', {
  method: 'GET',
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
  'https://api.royalti.io/webhook-deliveries',
)

data = response.json()
print(data)
curl -X GET https://api.royalti.io/webhook-deliveries \

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
status
enum<string>

Filter by delivery status

Available options:
pending,
success,
failed,
timeout,
cancelled
eventType
string

Filter by event type

webhookConfigId
string

Filter by webhook configuration ID

startDate
string<date-time>

Filter deliveries from this date

endDate
string<date-time>

Filter deliveries until this date

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
responseTimeMs,
attemptNumber,
deliveryStatus
sortOrder
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC

Response

Webhook deliveries retrieved successfully

status
string
Example:

"success"

message
string
Example:

"Webhook deliveries retrieved successfully"

data
object