/webhooks

GET /webhooks

List all webhooks

Retrieve a list of all webhooks for the current account

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

page query integer

Page number for pagination

pageSize query integer

Number of items per page

Try it out

Output:

Responses

Description

List of webhooks

{
  "webhooks": [
    {
      "id": 0,
      "name": "string",
      "url": "string",
      "active": false,
      "description": "string",
      "headers": {},
      "events": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0,
  "currentPage": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Webhook #/components/schemas/WebhookList

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

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

#/components/schemas/Webhook

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    readOnly: true
  name:
    type: string
    description: Name of the webhook
  url:
    type: string
    description: URL where webhook events will be sent
  active:
    type: boolean
    description: Whether the webhook is active
  description:
    type: string
    description: Description of the webhook
  headers:
    type: object
    additionalProperties:
      type: string
    description: Custom headers to send with the webhook request
  events:
    type: array
    items:
      type: string
    description: List of events the webhook is subscribed to
  createdAt:
    type: string
    format: date-time
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    readOnly: true
  createdBy:
    type: string
    readOnly: true
  updatedBy:
    type: string
    readOnly: true
required:
  - id
  - name
  - url
  - active
  - events

|
export interface Webhook {
  id: number;
  /** Name of the webhook */
  name: string;
  /** URL where webhook events will be sent */
  url: string;
  /** Whether the webhook is active */
  active: boolean;
  /** Description of the webhook */
  description?: string;
  /** Custom headers to send with the webhook request */
  headers?: Record<string, string>;
  /** List of events the webhook is subscribed to */
  events: string[];
  createdAt?: Date;
  updatedAt?: Date;
  createdBy?: string;
  updatedBy?: string;
}

#/components/schemas/WebhookList

OpenAPI
TypeScript

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

|
export interface WebhookList {
  webhooks?: Webhook[];
  /** Total number of webhooks 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/route.ts

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