List Webhook

List Webhook resources.

List webhooks

As of this writing, you can list webhooks via API. In future releases, we will allow you to list webhooks via Dashboard.

---

Endpoint

GET /webhooks

Sample code

curl

curl --location 'https://api.payrexhq.com/webhooks' \
  -u replace_with_secret_api_key: \
  --data-urlencode 'limit=1'

Node

const client = require('payrex-node')('insert your PayRex Secret API key.');

const webhooks = await client.webhooks.list({
  limit: 1,
});

PHP

$client = new \Payrex\PayrexClient('insert your PayRex Secret API key.');

$webhooks = $client->webhooks->list(
  [
    'limit' => 1,
  ]
);

Python

from payrex import Client as PayrexClient

client = PayrexClient('insert your PayRex Secret API key.')

webhooks = client.webhooks.list(
    {
        'limit': 1
    }
)

Ruby

client = Payrex::Client.new("insert your PayRex Secret API key.")

webhooks = client.webhook.list(
  limit: 1
)

Parameters

limit optional

Limits the number of resources returned by the endpoint. The minimum value is 1, and the maximum is 100.

---

before optional

A cursor used in pagination. before is a resource ID that defines your place in the list. For example, if you call a list request and receive 10 resources, starting with wh_1234, your subsequent calls can include before=wh_1234 to fetch the previous page of the list.

---

after optional

A cursor used in pagination. after is a resource ID that defines your place in the list. For example, if you call a list request and receive 10 resources, ending with wh_1234, your subsequent calls can include after=wh_1234 to fetch the next page of the list.

---

url optional

You can search your webhooks via url.

---

description optional

You can search your webhooks via description.

Returns

Returns a paginated list of Webhook resources.