Skip to main content
GET
/
webhook
/
{id}
/
logs
cURL
curl --request GET \
  --url https://api.openformat.tech/v1/webhook/{id}/logs \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.openformat.tech/v1/webhook/{id}/logs"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.openformat.tech/v1/webhook/{id}/logs', 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.openformat.tech/v1/webhook/{id}/logs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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.openformat.tech/v1/webhook/{id}/logs"

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

req.Header.Add("X-API-KEY", "<api-key>")

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.openformat.tech/v1/webhook/{id}/logs")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.openformat.tech/v1/webhook/{id}/logs")

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

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

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "total": 1234,
  "page": 2,
  "page_size": 20,
  "data": [
    {
      "webhook_id": 123,
      "event": "transaction",
      "idempotency_key": "a8eb78c3-2b45-4e9e-bf60-9296067fd593",
      "url": "https://api.example.com/webhook",
      "payload": "<any>",
      "successful": true,
      "response_code": 200,
      "error_message": "ConnectionError",
      "created_at": "2024-01-23 01:23:45.55338+00"
    }
  ]
}
{
  "success": false,
  "error": {
    "issues": [
      {
        "validation": "regex",
        "code": "invalid_string",
        "message": "Invalid",
        "path": [
          "id"
        ]
      }
    ],
    "name": "ZodError"
  }
}
{
  "status": "failed",
  "error": "Webhook not found"
}
{
  "status": "failed",
  "error": "Database operation failed"
}
{
  "status": "success",
  "total": 1234,
  "page": 2,
  "page_size": 20,
  "data": [
    {
      "webhook_id": 123,
      "event": "transaction",
      "idempotency_key": "a8eb78c3-2b45-4e9e-bf60-9296067fd593",
      "url": "https://api.example.com/webhook",
      "payload": "<any>",
      "successful": true,
      "response_code": 200,
      "error_message": "ConnectionError",
      "created_at": "2024-01-23 01:23:45.55338+00"
    }
  ]
}
{
  "success": false,
  "error": {
    "issues": [
      {
        "validation": "regex",
        "code": "invalid_string",
        "message": "Invalid",
        "path": [
          "id"
        ]
      }
    ],
    "name": "ZodError"
  }
}
{
  "status": "failed",
  "error": "Webhook not found"
}
{
  "status": "failed",
  "error": "Database operation failed"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string
required

Webhook id

Pattern: ^\d+$
Example:

"123"

Query Parameters

page
string

Results page Page to return

Pattern: ^\d+$
Example:

"1"

page_size
string

Page size

Pattern: ^\d+$
Example:

"20"

Response

Webhook logs

status
enum<string>
required

Successful reponse status

Available options:
success
Example:

"success"

total
number
required

Total amount of logs

Example:

1234

page
number
required

Current page

Example:

2

page_size
number
required

Page size

Example:

20

data
object[]
required

Webhook call logs