List webhook subscriptions

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/webhook-subscriptions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true,
      "url": "<string>",
      "rotating": true,
      "type": "webhook-subscription",
      "merchant_account_id": "default",
      "authentication": {
        "kind": "basic",
        "password": "super-strong-password",
        "username": "gr4vy"
      },
      "secret": "234567890abcdef1234567890abcdef",
      "creator": {
        "email_address": "[email protected]",
        "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
        "name": "Jhon Doe"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

GET

webhook-subscriptions

List webhook subscriptions

using RestSharp;


var options = new RestClientOptions("https://api.sandbox.{id}.gr4vy.app/webhook-subscriptions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true,
      "url": "<string>",
      "rotating": true,
      "type": "webhook-subscription",
      "merchant_account_id": "default",
      "authentication": {
        "kind": "basic",
        "password": "super-strong-password",
        "username": "gr4vy"
      },
      "secret": "234567890abcdef1234567890abcdef",
      "creator": {
        "email_address": "[email protected]",
        "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
        "name": "Jhon Doe"
      }
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

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 use for this request. The ID of the merchant account to use for this request.

Query Parameters

limit

integer

default:20

cursor

string | null

Response

Successful Response

items

WebhookSubscription · object[]

required

A list of items returned for this request.

Show child attributes

items.id

string<uuid>

required

The ID of the webhook subscription

items.active

boolean

required

Flag to determine whether this subscription should be sent webhook payloads.

items.url

string

required

URL to send webhook payloads.

items.rotating

boolean

required

Flag to determine whether the subscription has a secret rotation in progress or not.

items.type

string

default:webhook-subscription

Type of resource for webhook subscriptions.

Allowed value: "webhook-subscription"

items.merchant_account_id

string | null

The merchant account to which this subscription is associated. When null this represents an instance level webhook.

Example:

"default"

items.authentication

BasicAuthentication · object

Optional authentication configuration for webhook requests.

Show child attributes

items.authentication.username

string

required

The username value for basic auth.

items.authentication.type

string

default:webhook-authentication

Type of resource for webhook authentication.

Allowed value: "webhook-authentication"

items.authentication.kind

string

default:basic

Type of authentication for webhook request.

Allowed value: "basic"

items.authentication.password

string

default:********

The masked password value for basic auth.

Allowed value: "********"

Example:

{
  "kind": "basic",
  "password": "super-strong-password",
  "username": "gr4vy"
}

items.secret

string | null

The active secret value.

Example:

"234567890abcdef1234567890abcdef"

items.creator

Creator · object

The user that created this resource

Show child attributes

items.creator.id

string<uuid>

required

items.creator.name

string

required

items.creator.email_address

string

required

Example:

{
  "email_address": "[email protected]",
  "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
  "name": "Jhon Doe"
}

limit

integer

default:20

The number of items for this page.

Required range: 1 <= x <= 100

next_cursor

string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor

string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"

Create URL for executed report

Create webhook subscription

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Connections

Errors

Other

List webhook subscriptions

Authorizations

Headers

Query Parameters

Response