Skip to main content
POST
/
v2
/
webhook-endpoints
Create webhook endpoint
curl --request POST \
  --url https://sandbox.groundtech.co/v2/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "portfolio_wallet.balance.updated"
  ],
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "secret": "<string>"
}

Authorizations

​
Authorization
string
header
required

API keys are prefixed ground_sandbox_ (sandbox) or ground_prod_ (production). Pass the key as a Bearer token in the Authorization header.

Body

application/json
​
url
string<uri>
required

HTTPS callback URL to receive webhook events. HTTP is allowed in sandbox only.

​
events
enum<string>[]
required

Event types to subscribe to.

Available options:
portfolio_wallet.balance.updated,
portfolio_wallet.deposit.status_changed,
portfolio_wallet.withdrawal.status_changed,
portfolio_wallet.withdrawal.payout.status_changed,
portfolio_wallet.position.updated
​
description
string

Optional human-readable description.

Response

Webhook endpoint created

​
id
string<uuid>
​
url
string<uri>
​
events
string[]
​
createdAt
string<date-time>
​
secret
string

Signing secret (hex-encoded). Only returned on creation. Store securely.