# List webhooks

List webhooks

Endpoint: GET /v2/webhooks
Version: 2.0
Security: TokenAuth

## Query parameters:

  - `pageSize` (integer)
    The number of results to return per page (default 50, max 100)

  - `pageToken` (string)
    The token to retrieve the next page of results

  - `pagination.pageSize` (integer)
    Number of results per page (default 50, max 1000)

  - `pagination.pageToken` (string)
    Token for pagination from previous response

  - `pagination.orderBy` (string)
    Field to order results by

  - `pagination.order` (string)
    Sort order (ASC or DESC)
    Enum: "SORT_ORDER_ASC", "SORT_ORDER_DESC"

  - `filter.id.eq` (string)
    Exact match

  - `filter.id.notEq` (string)
    Not equal to

  - `filter.id.contains` (string)
    Contains substring (case-insensitive)

  - `filter.id.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.id.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.id.in` (array)
    Value is in the list

  - `filter.id.notIn` (array)
    Value is not in the list

  - `filter.id.isNull` (boolean)
    Check if field is null

  - `filter.name.eq` (string)
    Exact match

  - `filter.name.notEq` (string)
    Not equal to

  - `filter.name.contains` (string)
    Contains substring (case-insensitive)

  - `filter.name.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.name.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.name.in` (array)
    Value is in the list

  - `filter.name.notIn` (array)
    Value is not in the list

  - `filter.name.isNull` (boolean)
    Check if field is null

  - `filter.description.eq` (string)
    Exact match

  - `filter.description.notEq` (string)
    Not equal to

  - `filter.description.contains` (string)
    Contains substring (case-insensitive)

  - `filter.description.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.description.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.description.in` (array)
    Value is in the list

  - `filter.description.notIn` (array)
    Value is not in the list

  - `filter.description.isNull` (boolean)
    Check if field is null

  - `filter.endpoint.eq` (string)
    Exact match

  - `filter.endpoint.notEq` (string)
    Not equal to

  - `filter.endpoint.contains` (string)
    Contains substring (case-insensitive)

  - `filter.endpoint.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.endpoint.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.endpoint.in` (array)
    Value is in the list

  - `filter.endpoint.notIn` (array)
    Value is not in the list

  - `filter.endpoint.isNull` (boolean)
    Check if field is null

  - `filter.createdAt.eq` (string)
    Exact timestamp match

  - `filter.createdAt.notEq` (string)
    Not equal to timestamp

  - `filter.createdAt.before` (string)
    Before this timestamp

  - `filter.createdAt.after` (string)
    After this timestamp

  - `filter.createdAt.gte` (string)
    Greater than or equal to timestamp

  - `filter.createdAt.lte` (string)
    Less than or equal to timestamp

  - `filter.createdAt.between.start` (string)
    Start of time range (inclusive)

  - `filter.createdAt.between.end` (string)
    End of time range (inclusive)

  - `filter.createdAt.isNull` (boolean)
    Check if field is null

  - `filter.createdAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `filter.updatedAt.eq` (string)
    Exact timestamp match

  - `filter.updatedAt.notEq` (string)
    Not equal to timestamp

  - `filter.updatedAt.before` (string)
    Before this timestamp

  - `filter.updatedAt.after` (string)
    After this timestamp

  - `filter.updatedAt.gte` (string)
    Greater than or equal to timestamp

  - `filter.updatedAt.lte` (string)
    Less than or equal to timestamp

  - `filter.updatedAt.between.start` (string)
    Start of time range (inclusive)

  - `filter.updatedAt.between.end` (string)
    End of time range (inclusive)

  - `filter.updatedAt.isNull` (boolean)
    Check if field is null

  - `filter.updatedAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `filter.lastSuccess.eq` (string)
    Exact timestamp match

  - `filter.lastSuccess.notEq` (string)
    Not equal to timestamp

  - `filter.lastSuccess.before` (string)
    Before this timestamp

  - `filter.lastSuccess.after` (string)
    After this timestamp

  - `filter.lastSuccess.gte` (string)
    Greater than or equal to timestamp

  - `filter.lastSuccess.lte` (string)
    Less than or equal to timestamp

  - `filter.lastSuccess.between.start` (string)
    Start of time range (inclusive)

  - `filter.lastSuccess.between.end` (string)
    End of time range (inclusive)

  - `filter.lastSuccess.isNull` (boolean)
    Check if field is null

  - `filter.lastSuccess.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `filter.lastFailure.eq` (string)
    Exact timestamp match

  - `filter.lastFailure.notEq` (string)
    Not equal to timestamp

  - `filter.lastFailure.before` (string)
    Before this timestamp

  - `filter.lastFailure.after` (string)
    After this timestamp

  - `filter.lastFailure.gte` (string)
    Greater than or equal to timestamp

  - `filter.lastFailure.lte` (string)
    Less than or equal to timestamp

  - `filter.lastFailure.between.start` (string)
    Start of time range (inclusive)

  - `filter.lastFailure.between.end` (string)
    End of time range (inclusive)

  - `filter.lastFailure.isNull` (boolean)
    Check if field is null

  - `filter.lastFailure.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `search` (string)
    Case-insensitive search over webhook ID, name, description, and endpoint.

## Response 200 fields (application/json):

  - `filter` (object)

  - `filter.previousPageToken` (string)
    The token to retrieve the previous page of results
    Example: "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA="

  - `filter.nextPageToken` (string)
    The token to retrieve the next page of results
    Example: "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA="

  - `filter.total` (integer, required)
    The total number of results
    Example: 100

  - `webhooks` (array)

  - `webhooks.id` (string, required)
    The webhook ID.
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `webhooks.createdBy` (string, required)
    The ID of the user who created this webhook
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `webhooks.createdAt` (string, required)
    The date and time the webhook was created
    Example: "2022-03-29T10:22:22.420Z"

  - `webhooks.updatedBy` (string, required)
    The ID of the user who updated this webhook
    Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"

  - `webhooks.updatedAt` (string, required)
    The date and time the webhook was updated
    Example: "2022-03-29T10:22:22.420Z"

  - `webhooks.name` (string, required)
    The webhook name
    Example: "Palisade Transactions"

  - `webhooks.description` (string)
    The webhook description
    Example: "A webhook used to monitor transactions"

  - `webhooks.endpoint` (string, required)
    The webhook endpoint to send data to
    Example: "https://palisade.co/webhook"

  - `webhooks.subscriptionCount` (integer, required)
    The number of subscriptions associated with the webhook
    Example: 5

  - `webhooks.publicKey` (string, required)
    The public key used to verify the webhook signature
    Example: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw=="

  - `webhooks.lastSuccess` (string)
    The timestamp of the last successful webhook delivery
    Example: "2022-03-29T10:22:22.420Z"

  - `webhooks.lastFailure` (string)
    The timestamp of the last failed webhook delivery
    Example: "2022-03-29T10:22:22.420Z"

  - `webhooks.successCount` (integer, required)
    The number of successful webhook deliveries in the last hour
    Example: 42

  - `webhooks.failureCount` (integer, required)
    The number of failed webhook deliveries in the last hour
    Example: 3

## Response 400 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)