Clients

Update webhook URL

patch

Update or clear the webhook URL for the authenticated client. The webhook URL must use HTTPS if provided, or can be empty to clear it. Note this means webhooks will no longer be sent to your previous endpoint

Authorizations

BasicAuth

AuthorizationstringRequired

Body

application/json

webhook_urlstringOptionalExample: https://your-domain.com/webhooks/terra

Responses

200

Webhook URL updated successfully

application/json

client_idstringOptionalExample: client_abc123

customer_idstringOptionalExample: cust_xyz789

webhook_urlstringOptionalExample: https://your-domain.com/webhooks/terra

400

Bad request - invalid URL format or validation error

application/json

401

Unauthorized - invalid client credentials

application/json

404

Client not found

application/json

500

Internal server error

application/json

patch

/clients/webhook-url

HTTPcURLJavaScriptPython

PATCH /clients/webhook-url HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "webhook_url": "https://your-domain.com/webhooks/terra"
}

{
  "client_id": "client_abc123",
  "customer_id": "cust_xyz789",
  "webhook_url": "https://your-domain.com/webhooks/terra"
}