Get integration brief

The same contract as a single markdown document written for a coding agent: what to build, signature verification with a code sample, idempotency and replay rules, the retry schedule to tolerate, and the exact payload as a test fixture. Hand the `instructions` string to your agent alongside your codebase.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
`productId`	No	Write the brief for one product's purchases
`skuId`	No	Which variant the example payload should describe
`secretEnvVar`	No	Env var name the brief tells the implementer to read the signing secret from. Default `HYAX_WEBHOOK_SECRET`

Request

curl -X GET 'https://platform.hyax.com/hyax-api/v1/webhooks/integration-brief?productId=clx_product_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "format": "markdown",
    "instructions": "# Implement a Hyax purchase webhook receiver for the product \"Studio Tee\"\n\n…",
    "endpointUrls": ["https://api.example.com/hooks/hyax"]
  }
}

Request

curl -X GET 'https://platform.hyax.com/hyax-api/v1/webhooks/integration-brief?productId=clx_product_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "format": "markdown",
    "instructions": "# Implement a Hyax purchase webhook receiver for the product \"Studio Tee\"\n\n…",
    "endpointUrls": ["https://api.example.com/hooks/hyax"]
  }
}