Webhook Calls

These endpoints allow you to view webhook call logs.

Webhook calls are records of notifications that have been sent to webhook URLs. Each call includes the HTTP response code, headers, and body received from the webhook endpoint. These records are read-only and cannot be modified.

This can be used to debug issues with webhooks, or to verify that notifications are being sent correctly.

Webhook calls are kept in the system for 60 days, after which they are automatically deleted.

Endpoints

get /api/v3/notification/webhook/:webhook_id/calls get /api/v3/notification/webhook/:webhook_id/calls/:resource_id

get/api/v3/notification/webhook/:webhook_id/calls

Return a paginated list of notification/webhook/calls

Input Schema

object
The ID of the webhook to view call logs for.
webhook_id: integer
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
webhook_id?: unknown
http_code?: unknown
headers?: unknown
body?: unknown
created_at?: unknown
http_code?: unknown
http_code__lte?: unknown
http_code__gte?: unknown
http_code__lt?: unknown
http_code__gt?: unknown
created_at__gte?: unknown
created_at__lte?: unknown
created_at__gt?: unknown
created_at__lt?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  // The ID of the webhook to view call logs for.
  webhook_id: number;
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    webhook_id?: any;
    http_code?: any;
    headers?: any;
    body?: any;
    created_at?: any;
    http_code?: any;
    http_code__lte?: any;
    http_code__gte?: any;
    http_code__lt?: any;
    http_code__gt?: any;
    created_at__gte?: any;
    created_at__lte?: any;
    created_at__gt?: any;
    created_at__lt?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: string
http_code?: integer
headers?: string
body?: string
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: string;
      http_code?: number;
      headers?: string;
      body?: string;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

get/api/v3/notification/webhook/:webhook_id/calls/:resource_id

Show a specific notification/webhook/calls

Input Schema

object
The ID of the webhook to view call logs for.
webhook_id: integer
resource_id: string
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  // The ID of the webhook to view call logs for.
  webhook_id: number;
  resource_id: string;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: string
http_code?: integer
headers?: string
body?: string
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: string;
      http_code?: number;
      headers?: string;
      body?: string;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};