Skip to main content
POST
Create a gtoken webhook
Register an HTTPS endpoint for gtoken and fee-wrapper lifecycle events. Store the returned signing secret securely; Ground returns it only once.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required

Public HTTPS callback URL. Credentials, private or loopback hosts, and nonstandard ports are rejected.

Pattern: ^https://
Example:

"https://ops.acme.com/webhooks/ground-gvaults"

events
enum<string>[]
required
Minimum array length: 1
Available options:
gvault.allowlist.status_changed,
fee_wrapper.status_changed,
fee_wrapper.fees.status_changed,
fee_wrapper.allowlist.status_changed
description
string | null

Response

Webhook created; secret is returned once.

id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"8f4c52d7-62ab-4db9-a964-92f481f6b851"

url
string<uri>
required

Public HTTPS callback URL. Credentials, private or loopback hosts, and nonstandard ports are rejected.

Pattern: ^https://
Example:

"https://ops.acme.com/webhooks/ground-gvaults"

events
enum<string>[]
required
Available options:
gvault.allowlist.status_changed,
fee_wrapper.status_changed,
fee_wrapper.fees.status_changed,
fee_wrapper.allowlist.status_changed
createdAt
string<date-time>
required
secret
string

Returned only when the webhook is created.