Webhooks

Create a webhook subscription

Subscribes an HTTPS URL to receive signed JSON payloads for selected ScaleForge events. The response contains a one-time secret used to verify HMAC-SHA256 signatures — store it securely, it is not retrievable later. Requires scope webhooks:write.

post/api/v1/webhook_subscriptions

Request

  • Base URL: https://getscaleforge.com
  • URL: https://getscaleforge.com/api/v1/webhook_subscriptions
  • Auth: HTTP bearer

Request body

urlstring uri required
eventsstring[] required

Example request

{
  "url": "https://example.com/webhooks/scaleforge",
  "events": [
    "upload.completed",
    "campaign.activated"
  ]
}

Response

Subscription created

Example response

{
  "data": {
    "id": 3,
    "url": "https://example.com/webhooks/scaleforge",
    "events": [
      "upload.completed",
      "campaign.activated",
      "bid_change.applied"
    ],
    "active": true,
    "secret": "whsec_abc123..."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.