Lists webhook endpoints

Request

GET {{baseURL}}/v2/webhooks/endpoints

This endpoint lists all webhook endpoints.

The endpoints are for both active and inactive webhooks.

This endpoint does not require a specific API token. Either a merchant or partner API token can be used.

See Also:
To create a webhook, see POST /v2/webhooks/endpoints.
To retrieve a specified webhook, see GET /v2/webhooks/endpoints/{{endpointId}}.
To update a webhook, see PATCH /v2/webhooks/endpoints/{{endpointId}}.

Security

Bearer

Query

pageIndexinteger, (int32), >= 0

Specifies the page number of the returned search results.

A page is considered each set of the pageSize values.

The page count is zero-based. The maximum for pageIndex, or the page number, is the pageSize divided by the total count rounded down. For example, the pageSize is 50 and the total is 130. That means there are three pages, but the pageIndex value is in the inclusive range from zero to two.

Value restrictions include:

A value less than zero is not permitted.
Values equal to or greater than totalPages end successfully but will not return any items.

For page size information, see pageSize.

Example: 0

Default:0

pageSizeinteger, (int32), [ 1 .. 100 ]

Specifies the number of items for each page of the returned search results.

A page is considered each set of the pageSize values.

For page numbering information, see pageIndex.

Example: 50

Default:20

sortOrderstring, <= 4 characters

Specifies the sort order.

The sort order is specified by the sortOrder value.
The field that gets sorted by is specified by the sortBy value.

Valid values are:

Value	Description
asc	Sorts results in ascending order, from the lowest value to the highest, or from the oldest timestamp to the most recent.
desc	Sorts results in descending order, from the highest value to the lowest, or from the most recent timestamp to the oldest.

Default:"desc"

Example:sortOrder=desc

sortBystring

Specifies a field name to sort the results by.

If null or omitted, results come back newest first.

The sort order is specified by the sortOrder value.

The following fields may be used to sort results:
endpointId
endpointName
endpointUrl
endpointStatus
createdOn
modifiedOn

Example: endpointId

Example:sortBy=endpointId

fromDatestring, (date-time)

Specifies a filter to return items at or after this date-time (in an ISO 8601 date-time format).

If only fromDate is specified, the search returns all available items from the fromDate value to the present. The fields fromDate and toDate may be used together to create an inclusive range. We recommend creating an inclusive range to avoid a potentially excessive number of returns.

Example: 2025-01-27T12:05:54.322Z

Example:fromDate=2025-01-27T12:05:54.322Z

toDatestring, (date-time)

Specifies a filter to return items at or before this date-time (in an ISO 8601 date-time format).

If only toDate is specified, the search returns all available items up to the toDate value. The fields fromDate and toDate may be used together to create an inclusive range. We recommend creating an inclusive range to avoid a potentially excessive number of returns.

Example: 2026-02-27T12:05:54.322Z

Example:toDate=2026-02-27T12:05:54.322Z

endpointStatusstring, <= 8 characters

Filters by the endpoint status.

Valid values are:

Value	Description
Active	The webhook endpoint is enabled and available for use.
Inactive	The webhook endpoint is disabled and not available for use. It still exists but will not send event notifications. It may be re-activated. In contrast, a deleted webhook has been removed entirely and cannot be re-activated. A new webhook must be created.

Example: Active

Enum:"Active""Inactive"

Example:endpointStatus=Active

searchstring

Filters using a search string.

This performs a case-insensitive search that matches exactly or partially. Multiple fields may be included to return precise results.

The field does not have to be specified. If the results are to be sorted, use the sortBy field to specify the sort field.

The following fields are searched:
endpointName
endpointUrl

Example:
https://webhook.flute.com/webhooks (example EndpointUrl)
PepparedStreetCafe-PurchaseCompleted-Webhook (example WebhookName)

Example:search=PepparedStreetCafe-PurchaseCompleted-Webhook

curl -i -X GET \
  'https://sandbox.api.flute.com/v2/webhooks/endpoints?pageIndex=0&pageSize=20&sortOrder=desc&sortBy=endpointId&fromDate=2025-01-27T12%3A05%3A54.322Z&toDate=2026-02-27T12%3A05%3A54.322Z&endpointStatus=Active&search=PepparedStreetCafe-PurchaseCompleted-Webhook' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

dataArray of objects or null

Indicates an object list of webhook details.

Example:

[
  {
    "items": [
      {
        "endpointId": "633649fc-9d16-4d1b-98ec-73a3282427fc",
        "endpointName": "Peppared Street Cafe's Reconciliation",
        "endpointUrl": "https://example.com/webhooks/pepparedstreetcafe",
        "endpointStatus": "Active",
        "eventTypes": [
          "transaction.card.captured",
          "settlement.batch.completed"
        ],
        "createdOn": "2026-05-05T14:30:36.759Z",
        "modifiedOn": "2026-07-10T03:22:47.918Z"
      }
    ]
  }
]

Response

{
  "data": [
    {
      "items": [
        {
          "endpointId": "633649fc-9d16-4d1b-98ec-73a3282427fc",
          "endpointName": "Peppared Street Cafe's Reconciliation",
          "endpointUrl": "https://example.com/webhooks/pepparedstreetcafe",
          "endpointStatus": "Active",
          "eventTypes": [
            "transaction.card.captured",
            "settlement.batch.completed"
          ],
          "createdOn": "2026-05-05T14:30:36.759Z",
          "modifiedOn": "2026-07-10T03:22:47.918Z"
        }
      ]
    }
  ]
}