/webhooks/{id}/logs

GET /webhooks/{id}/logs

Get webhook delivery logs

Retrieve logs of webhook deliveries

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

id path integer

The ID of the webhook

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

Page number for pagination

pageSize query integer

Number of items per page

Try it out

Output:

Responses

Description

Webhook logs

{
  "logs": [
    {
      "id": 0,
      "eventName": "string",
      "requestPayload": {},
      "responseStatus": 0,
      "responseBody": "string",
      "errorMessage": "string",
      "createdAt": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0,
  "currentPage": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/WebhookLog #/components/schemas/WebhookLogList

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/WebhookLog

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    readOnly: true
  eventName:
    type: string
    description: Name of the event that triggered the webhook
  requestPayload:
    type: object
    description: Payload sent in the webhook request
  responseStatus:
    type: integer
    description: HTTP status code of the response
  responseBody:
    type: string
    description: Response body (truncated if too large)
  errorMessage:
    type: string
    description: Error message if the webhook delivery failed
  createdAt:
    type: string
    format: date-time
    description: When the webhook was delivered
required:
  - id
  - eventName
  - createdAt

|
export interface WebhookLog {
  id: number;
  /** Name of the event that triggered the webhook */
  eventName: string;
  /** Payload sent in the webhook request */
  requestPayload?: {};
  /** HTTP status code of the response */
  responseStatus?: number;
  /** Response body (truncated if too large) */
  responseBody?: string;
  /** Error message if the webhook delivery failed */
  errorMessage?: string;
  /** When the webhook was delivered */
  createdAt: Date;
}

#/components/schemas/WebhookLogList

OpenAPI
TypeScript

type: object
properties:
  logs:
    type: array
    items:
      $ref: "#/components/schemas/WebhookLog"
  totalCount:
    type: integer
    description: Total number of logs matching the query
  totalPages:
    type: integer
    description: Total number of pages
  currentPage:
    type: integer
    description: Current page number

|
export interface WebhookLogList {
  logs?: WebhookLog[];
  /** Total number of logs matching the query */
  totalCount?: number;
  /** Total number of pages */
  totalPages?: number;
  /** Current page number */
  currentPage?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /webhooks/[id]/logs/route.ts

Or the swagger.yaml spec this documentation was generated from: /webhooks/swagger.yaml