GET
/
webhook-subscriptions
/
{webhook_subscription_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/webhook-subscriptions/{webhook_subscription_id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

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"

Path Parameters

​
webhook_subscription_id
string
required

The ID for the webhook subscription.

Example:

"8fd77b13-a5e3-43de-bd54-26a8a714ac18"

Response

200
application/json
Returns a webhook subscription.
​
type
enum<string>

webhook-subscription.

Available options:
webhook-subscription
Example:

"webhook-subscription"

​
id
string

The unique Gr4vy ID for this webhook subscription.

Example:

"8fd77b13-a5e3-43de-bd54-26a8a714ac18"

​
merchant_account_id
string | null

The unique ID for a merchant account.

Example:

"default"

​
active
boolean

Defines if this subscription is currently active or not. When deactivated, webhook events are not sent to the endpoint configured for this subscription.

Example:

true

​
url
string

The URL of the endpoint to deliver webhook events to.

Example:

"https://example.com/webhooks"

​
authentication
object

Was this page helpful?

Suggest edits