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

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
Example:

"https://api.partner.com/webhooks/ground"

​
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,
portfolio_wallet.strategy.status_changed
​
description
string
Example:

"Alerts our ledger service when balances change"

Response

Webhook endpoint created

​
id
string<uuid>
​
url
string
​
events
string[]
​
signingSecret
string

Only returned on creation. Store securely.

​
createdAt
string<date-time>