GET
/
webhook-subscriptions
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "type": "webhook-subscription",
      "id": "8fd77b13-a5e3-43de-bd54-26a8a714ac18",
      "merchant_account_id": "default",
      "active": true,
      "url": "https://example.com/webhooks",
      "authentication": {
        "kind": "basic",
        "username": "username",
        "password": "password"
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

This endpoint requires the webhook-subscriptions.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Gr4vy-Merchant-Account-ID
string

The ID of the merchant account to act upon. When not or provided, this value will default to the first merchant account a user has access to. This value can be set to * on some APIs to fetch resources from all merchant accounts.

Maximum length: 255
Example:

"default"

Response

200
application/json
Returns a list of webhook subscriptions.
​
items
object[]

A list of webhook subscriptions.

​
limit
integer
default:20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 <= x <= 100
Example:

1

​
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

"ZXhhbXBsZTE"

​
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
Example:

null

Was this page helpful?

Suggest edits