Skip to main content
POST
/
webhook-subscriptions
Create webhook subscription
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>");
request.AddJsonBody("{\n  \"url\": \"<string>\",\n  \"active\": true,\n  \"authentication\": {\n    \"kind\": \"basic\",\n    \"password\": \"super-strong-password\",\n    \"username\": \"gr4vy\"\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active": true,
  "url": "<string>",
  "rotating": true,
  "type": "webhook-subscription",
  "merchant_account_id": "default",
  "authentication": {
    "kind": "basic",
    "password": "********",
    "username": "gr4vy"
  },
  "secret": "234567890abcdef1234567890abcdef",
  "creator": {
    "email_address": "[email protected]",
    "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
    "name": "Jhon Doe"
  }
}
This endpoint requires the webhook-subscriptions.write 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 | null

The ID of the merchant account to use for this request.

Example:

"default"

Body

application/json
​
url
string
required

URL to send webhook payloads.

​
active
boolean
default:true

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

​
authentication
BasicAuthenticationCreate · object

Optional authentication configuration for webhook requests.

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

Response

Successful Response

​
id
string<uuid>
required

The ID of the webhook subscription

​
active
boolean
required

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

​
url
string
required

URL to send webhook payloads.

​
rotating
boolean
required

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

​
type
string
default:webhook-subscription

Type of resource for webhook subscriptions.

Allowed value: "webhook-subscription"
​
merchant_account_id
string | null

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

Example:

"default"

​
authentication
BasicAuthentication · object

Optional authentication configuration for webhook requests.

Example:
{
  "kind": "basic",
  "password": "********",
  "username": "gr4vy"
}
​
secret
string | null

The active secret value.

Example:

"234567890abcdef1234567890abcdef"

​
creator
Creator · object

The user that created this resource

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