Webhooks

List outgoing webhook events

Returns paginated records of outgoing webhooks sent to your webhook URL. Webhooks are persisted for a fixed retention period of 7days.

get/transactions/webhooks

Request

Base URL
https://api.breet.io/v1
Auth
API key in header x-app-id and API key in header x-app-secret and API key in header X-Breet-Env
TypeScript
https://skmtc.dev/breet/apis/breet-public-api/docs/transactions/webhooks/get.ts
A function with typed inputs. Its response is checked against the schema.

pageinteger

Page number (1-indexed).

sizeinteger

Number of items per page (max 200 on the server).

sortstring

Optional sort expression (string).

filterstring

Optional filter expression (string).

exportsboolean

Optional export flag.

searchstring

Optional search string.

startDatestring date-time

If used with endDate, filters by date range (ISO 8601).

endDatestring date-time

If used with startDate, filters by date range (ISO 8601).

referencestring

Optional. The trade or withdrawal document ID (MongoDB ObjectId string) used as the webhook reference.

status'delivered' | 'failed'

Stored delivery outcome for the webhook event document.

Optional. Filter by overall delivery status of the stored webhook event.

Webhook event name (matches event / eventType for trade and withdrawal notifications).

Optional. Filter by webhook event type (matches eventType in the stored document).

Paginated list of webhook event documents

successboolean

{
  "success": true,
  "data": [
    {
      "id": "67a1b2c3d4e5f67890123456"
    }
  ]
}

Nov 3, 202641450811e16e Revision changes
- warning
  added the new trade.deleted enum value to the // response property for the response status
- info
  added the new enum value trade.deleted to the query request parameter eventName