Pax8

Interact with the Pax8 Partner API

Actions100

Webhooks → Query webhooks

AI-generated

Summary

Query Pax8 webhooks with optional filters, pagination controls, and return-all behavior.

Inputs

  • baseUrl — Base URL for the Pax8 API. Defaults to https://api.pax8.com if not set.
  • returnAll — Whether to return all results by paginating through every available page. Defaults to false; when true, maxResults and page/size parameters are governed by the return-all flow.
  • maxResults — Maximum number of results to return when returnAll is true. A value of 0 means no limit. Only displayed when returnAll is true.
  • query — Free-text string value used as a query filter for webhooks. Only displayed when returnAll is false.
  • page — Pagination offset parameter. Only displayed when returnAll is false.
  • size — Page size parameter limiting results per page. Only displayed when returnAll is false.
  • active — Filter webhooks by their last delivery status (true/false). Only displayed when returnAll is false.
  • topic — Topic filter for webhooks. Displayed regardless of returnAll setting.
  • sort — Sort field and order in field:asc/desc format. Displayed regardless of returnAll setting.
  • status — Filter webhooks by the last delivery status value. Displayed regardless of returnAll setting.
  • accountId — Filter webhooks by account identifier. Displayed regardless of returnAll setting.

Output shape

Array of webhook objects representing the requested list. When returnAll is false, the response contains a single page of results based on the provided pagination and filter parameters. When returnAll is true, the operation paginates through all available pages (respecting maxResults if set) and returns the aggregated collection. If the API returns no content, the raw response is returned as a fallback.

The underlying implementation (source.xml) uses async getWebhooks() which dispatches a GET request via makeRequest(qs) with constructed query parameters. List endpoints return { content, page } structures, and the node extracts the content array as the primary output. Pagination is handled server-side when returnAll is enabled.

Links

Discussion