Update webhook subscription

Update an existing webhook subscription’s properties. You can modify the subscription URL, authentication details, or toggle the active status. Only the fields you include in your request will be updated, and all other properties will remain unchanged.

PUT /webhook-subscriptions/{subscription_id}

Update webhook subscription

C#

using RestSharp;


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

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

200

{
  "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": "[e-mail]",
    "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

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

Example:

"default"

Path Parameters

subscription_id · string<uuid> · required

The ID of the webhook subscription

Example:

"ef9496d8-53a5-4aad-8ca2-00eb68334389"

Body

application/json

active · boolean | null

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

Example:

true

url · string | null

URL to send webhook payloads.

Example:

"https://www.gr4vy.com/webhooks"

authentication · BasicAuthenticationCreate · object

Optional authentication configuration for webhook requests.

BasicAuthenticationCreate

CredentialsOAuthAuthenticationCreate

PasswordOAuthAuthenticationCreate

Show child attributes

Example:

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

Response

200

application/json

Successful Response

id · string<uuid> · required

The ID of the webhook subscription

Example:

"ef9496d8-53a5-4aad-8ca2-00eb68334389"

active · boolean · required

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

Examples:

true

false

url · string · required

URL to send webhook payloads.

Example:

"https://www.gr4vy.com/webhooks"

rotating · boolean · required

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

Examples:

false

true

type · string · default: webhook-subscription

Type of resource for webhook subscriptions.

Allowed value: "webhook-subscription"

Example:

"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.

BasicAuthentication

CredentialsOAuthAuthentication

PasswordOAuthAuthentication

Show child attributes

Example:

{
  "kind": "basic",
  "password": "********",
  "username": "gr4vy"
}

secret · string | null

The active secret value.

Example:

"234567890abcdef1234567890abcdef"

creator · Creator · object

The user that created this resource

Show child attributes

Example:

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