Skip to main content
GET
/
api
/
v2
/
webhooks
List webhooks
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/webhooks \
  --header 'api-key: <api-key>' \
  --header 'entity-id: <api-key>'
{
  "totalResults": 100,
  "webhooks": [
    {
      "webhookId": "1234567890abcdef",
      "networkId": 1,
      "event": "CreatePayins",
      "postUrl": "https://example.com/webhook",
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

api-key
string
header
required
entity-id
string
header
required

Query Parameters

webhookId
string

Optional filter to retrieve a specific webhook by its unique identifier. If provided, returns only the webhook matching this ID

networkId
number

Optional filter to retrieve webhooks for a specific network. If provided, returns only the webhooks matching this network ID

event
enum<string>

Optional filter to retrieve webhooks for a specific event. If provided, returns only the webhooks matching this event. Valid options are payment.processed, payin.created, payin.canceled.

Available options:
payin.created,
payment.processed,
payment.missed
page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1.

limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

sortBy
string

Optional sorting parameter to specify the field to sort the results by. Valid options are "postUrl", "dateCreated". Default is "dateCreated".

sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

totalResults
number
required

The total count of webhooks matching the search criteria, regardless of page size or number.

Example:

100

webhooks
object[]
required

The list of webhooks.

I