Sign in
webhooks

List all webhook endpoints registered by your API key. (pay-authenticated access required)

Changed on

List webhook endpoints

get/webhooks

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/webhooks
  • Auth: API key in header token

Query parameters

paymentSourceIdstring nullable

Filter by payment source ID

cursorIdstring

Cursor ID to paginate through the results

limitnumber

Number of webhooks to return

Response

List of webhook endpoints

statusstring required

Example response

{
  "status": "Success",
  "data": {
    "Webhooks": [
      {
        "id": "webhook_endpoint_id",
        "url": "https://your-server.com/webhook",
        "name": "My Webhook",
        "Events": [
          "PURCHASE_ON_CHAIN_STATUS_CHANGED",
          "WALLET_LOW_BALANCE"
        ],
        "isActive": true,
        "createdAt": "1970-01-20T20:00:36.260Z",
        "updatedAt": "1970-01-20T20:00:36.260Z",
        "paymentSourceId": null,
        "failureCount": 0,
        "lastSuccessAt": "1970-01-20T20:00:36.260Z",
        "disabledAt": null,
        "CreatedBy": {
          "apiKeyId": "api_key_id",
          "apiKeyToken": "masked_token"
        }
      }
    ]
  }
}

Changes

  • 315a2a763fb7Revision changes
    • warning

      added the new HYDRA_HEAD_LOW_BALANCE enum value to the //// response property for the response status

  • 87b151d07425Revision changes
    • info

      removed the HYDRA_HEAD_LOW_BALANCE enum value from the //// response property for the response status