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>'
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.openformat.tech/llms.txt

Use this file to discover all available pages before exploring further.

{
  "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"
    }
  ]
}

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