Set or clear your webhook URL

​

Point your key's corporate-action webhook at an HTTPS URL — HoodGrow then POSTs each event there (see the Webhooks tag for the payload). Setting a non-null URL requires an active Builder subscription (403 otherwise); pass "webhookUrl": null to clear it (no subscription needed to clear). Each set rotates webhookSecret — the HMAC key that signs deliveries — so update your verifier when you change the URL.

Body
required
application/json
  • address
    Type: string
    required
  • webhookUrl
    Type: string | null Format: uri

    HTTPS URL, or null to clear. Non-HTTPS is rejected with 400.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/api/builder/key
curl https://www.hoodgrow.com/api/builder/key \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "address": "",
  "webhookUrl": null
}'

{
  "ok": true,
  "webhookUrl": "https://example.com/hooks/hoodgrow",
  "webhookSecret": "a1b2c3d4e5f60718293a4b5c6d7e8f9012345678"
}

Webhook set (or cleared).