Retrieve All Webhooks

Returns a paged list of Webhooks

Query parameters:

limit Maximum rows to return per page. Default 10.
start_index Default 1.
program_guid Optional. When supplied, only Webhooks belonging to this program are returned.

Only active Webhooks are returned.

Request

Security:

Bearer

path Parameters

version

required

string

query Parameters

limit	integer <int32> Default: 10
start_index	integer <int32> Default: 1
program_guid	string <uuid>

Responses

200

Returns list of the Webhook details

400

Bad request

401

Unauthorized

404

Webhook not found / program not found

500

Server Error

get/api/{version}/webhooks

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/webhooks?limit=10&start_index=1&program_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"notification_guid": "9c1d96b3-0c4d-4b89-9eb0-68c18dac59b2",
"program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
"url": "string",
"headers": "string",
"secret": "string",
"active": true,
"event_type": ["string"
]
}
],
"check_statuses": ["string"
]
}