PUT
/
webhook-subscriptions
/
{subscription_id}
Update webhook subscription
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.{id}.gr4vy.app/webhook-subscriptions/{subscription_id}"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"url\": \"https://www.gr4vy.com/webhooks\",\n  \"authentication\": {\n    \"kind\": \"basic\",\n    \"password\": \"super-strong-password\",\n    \"username\": \"gr4vy\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
{
  "id": "ef9496d8-53a5-4aad-8ca2-00eb68334389",
  "type": "webhook-subscription",
  "merchant_account_id": "default",
  "active": true,
  "url": "https://www.gr4vy.com/webhooks",
  "authentication": {
    "kind": "basic",
    "password": "super-strong-password",
    "username": "gr4vy"
  },
  "secret": "234567890abcdef1234567890abcdef",
  "rotating": false,
  "creator": {
    "email_address": "jhon.doe@gr4vy.com",
    "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.

Examples:

"default"

Path Parameters

​
subscription_id
string<uuid>
required

The ID of the webhook subscription

Examples:

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

Body

application/json
​
active
boolean | null

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

Examples:

true

false

​
url
string | null

URL to send webhook payloads.

Examples:

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

​
authentication
object | null

Optional authentication configuration for webhook requests.

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

Response

Successful Response

​
id
string<uuid>
required

The ID of the webhook subscription

Examples:

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

Examples:

"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"
Examples:

"webhook-subscription"

​
merchant_account_id
string | null

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

Examples:

"default"

null

​
authentication
object | null

Optional authentication configuration for webhook requests.

Examples:
{
  "kind": "basic",
  "password": "super-strong-password",
  "username": "gr4vy"
}
​
secret
string | null

The active secret value.

Examples:

"234567890abcdef1234567890abcdef"

​
creator
object | null

The user that created this resource

Examples:
{
  "email_address": "jhon.doe@gr4vy.com",
  "id": "07e70d14-a0c0-4ff5-bd4a-509959af0e4d",
  "name": "Jhon Doe"
}