Set the callback URL

Configure the destination that receives company-change notifications.

PUT/companies/watch/callback

Parameters

callbackbody · URLRequired

Your HTTPS webhook receiver.

Working with this response

This operation sets the callback without a company ID. Treat it as shared configuration; check the current URL before replacing it.
Keep the returned secret on the receiver’s server. Verify X-GD-Signature as the hex HMAC-SHA256 of the exact raw request body using the secret string before processing an event. Return HTTP 200 promptly; the provider documents a few retries of unsuccessful deliveries, checked once per minute. Ordering, a stable event ID and exactly-once delivery are not specified.

Response

200 · application/json

Illustrative callback configuration. The secret is generated on the first PUT and remains unchanged when the callback URL changes.

{
  "callback": "https://your-app.example/webhooks/company-changes",
  "secret": "YOUR_WEBHOOK_SECRET"
}

Request example

curl --fail-with-body --request PUT 'https://api.globaldatabase.com/v2/companies/watch/callback' \
  --header "Authorization: Token $GDB_API_KEY" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "callback": "https://your-app.example/webhooks/company-changes"
}'

Set GDB_API_KEY in your server environment. These examples are not executed by this page.