List all webhooks

GET 
/v1/webhooks

Retrieves a paginated list of webhooks

Request

Query Parameters

limit number

Possible values: >= 1 and <= 200

Default value: 20

The number of items to return

offset number

Default value: 0

The number of items to skip

Responses

200

Webhook list retrieved with success

application/json

Schema

Schema

traceId string
message string

data

object[]

Array [

id stringrequired

name stringrequired

subscribedEventTypes string[]required

Possible values: [WEBHOOK_CREATED, WEBHOOK_UPDATED, WEBHOOK_DELETED, CUSTOMER_CREATED, CUSTOMER_UPDATED, CUSTOMER_KYC_STARTED, CUSTOMER_KYC_SDK_FLOW_REQUIRED, CUSTOMER_KYC_SDK_FLOW_COMPLETED, CUSTOMER_KYC_FINISHED, CUSTOMER_KYC_RESTARTED, CUSTOMER_KYC_SDK_EXPIRED, CUSTOMER_KYC_ERROR, BANK_DEPOSIT_TRANSACTION_PENDING, BANK_DEPOSIT_TRANSACTION_COMPLETED, BANK_DEPOSIT_TRANSACTION_FAILED, BANK_WITHDRAWAL_TRANSACTION_PENDING, BANK_WITHDRAWAL_TRANSACTION_COMPLETED, BANK_WITHDRAWAL_TRANSACTION_FAILED, INTERNAL_TRANSACTION_COMPLETED, CRYPTO_DEPOSIT_TRANSACTION_PENDING, CRYPTO_DEPOSIT_TRANSACTION_COMPLETED, CRYPTO_DEPOSIT_TRANSACTION_FAILED, CRYPTO_WITHDRAWAL_TRANSACTION_PENDING, CRYPTO_WITHDRAWAL_TRANSACTION_COMPLETED, CRYPTO_WITHDRAWAL_TRANSACTION_FAILED, VIRTUAL_ACCOUNT_CREATED, ASSET_TRADE_SUCCESSFUL, ASSET_TRADE_FAIL, LTV_LIQUIDATED, LTV_LIQUIDATION_WARNING, LTV_URGENT_COLLATERAL_NEEDED, LTV_COLLATERAL_NEEDED, LTV_PURCHASE_RESTRICTED, LTV_THRESHOLD_WARNING, MEMBERSHIP_CONFIRMATION, COOP_AUTH_0100, COOP_AUTH_0120, COOP_AUTH_0200, COOP_AUTH_0220, COOP_AUTH_0420, CARD_TRANSACTION_PENDING, CARD_TRANSACTION_COMPLETED, CARD_TRANSACTION_FAILED, CARD_TRANSACTION_CANCELLED]

active booleanrequired

url stringrequired

]

pagination

object

totalResults numberrequired

hasMoreResults booleanrequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "subscribedEventTypes": [
        "WEBHOOK_CREATED"
      ],
      "active": true,
      "url": "string"
    }
  ],
  "pagination": {
    "totalResults": 0,
    "hasMoreResults": true
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...