Skip to main content
PUT
Update webhook subscription
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.

Example:

Response

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.

Example:
secret
string | null

The active secret value.

Example:

"234567890abcdef1234567890abcdef"

creator
Creator · object | null

The user that created this resource

Example: