List webhook configurations

{
  "data": [
    {
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "url": "https://example.com/webhook",
      "description": "Payment notifications webhook",
      "is_active": true,
      "event_types": [
        "payin.failed",
        "payin.settled",
        "payout.debited",
        "payout.failed",
        "payout.settled",
        "subaccount.credit_received"
      ]
    },
    {
      "created_at": "2024-03-20T12:00:00Z",
      "updated_at": "2024-03-20T12:00:00Z",
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "url": "https://example.com/webhook",
      "description": "Inactive webhook endpoint",
      "is_active": false,
      "event_types": [
        "payin.failed",
        "payin.settled",
        "payout.debited",
        "payout.failed",
        "payout.settled",
        "subaccount.credit_received"
      ]
    }
  ],
  "has_more": false,
  "total_count": 2
}

Lists all webhook configurations for the entity.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Query parameters

cursorstring or nullOptional

Cursor for pagination. Use the next_cursor from the previous response to get the next page.

limitintegerOptional10-500Defaults to 50

Number of items per page.

Response

List of webhook configurations retrieved successfully

datalist of objects

has_moreboolean

total_countinteger or null>=0Defaults to 0

next_cursorstring or null

previous_cursorstring or null

$	curl https://api.useroot.com/api/webhooks \
>	-H "x-api-key: <apiKey>"