# List webhooks

Returns a paginated list of registered webhooks for a given business, filtered by status, events and date range.

Endpoint: GET /webhooks/list/{businessId}
Version: 1.0

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

## Query parameters:

  - `limit` (string, required)
    Number of items to be loaded per page

  - `page` (string, required)
    Page number to access

  - `status` (string)
    Filter by webhook status.
    Enum: "active", "inactive", "unavailable"

  - `initialDate` (string)
    Start date for filtering (ISO 8601).

  - `endDate` (string)
    End date for filtering (ISO 8601).

  - `events` (string)
    Filter by webhook events (multiple events allowed).
    Enum: "order.chargeback", "order.updated", "order.canceled", "order.created", "order.paid", "order.partiallyPaid", "order.refunded", "subscription.created", "subscription.updated", "subscription.activated", "subscription.canceled", "subscription.deactivated", "subscription.expired", "subscription.inactivated", "subscriptionRecurrence.canceled", "subscriptionRecurrence.delayed", "subscriptionRecurrence.failed", "subscriptionRecurrence.paid"

## Path parameters:

  - `businessId` (string, required)

## Response 200 fields (application/json):

  - `statusCode` (integer)

  - `data` (object)

  - `data.docs` (array)

  - `data.docs.account` (string)

  - `data.docs.id` (string)

  - `data.docs.name` (string)

  - `data.docs.status` (string)
    Enum: "active", "inactive", "unavailable"

  - `data.docs.events` (array)

  - `data.docs.events.referer` (string)

  - `data.docs.dispatchers` (array)

  - `data.docs.dispatchers.createdAt` (string)

  - `data.docs.dispatchers.updatedAt` (string)

  - `data.docs.dispatchers.type` (string)
    Enum: "http"

  - `data.docs.dispatchers.method` (string)
    Enum: "POST", "PUT", "PATCH"

  - `data.docs.dispatchers.url` (string)

  - `data.docs.dispatchers.headers` (object)

  - `data.docs.notifyOnFail` (object)

  - `data.docs.notifyOnFail.email` (string)

  - `data.docs.queue` (string)

  - `data.totalDocs` (integer)

  - `data.totalPages` (integer)

  - `data.currentPage` (integer)

  - `data.limit` (integer)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500