GamebeastDocs
Dashboard
Project APIAnnotations

Receive an annotation webhook

POST
/ingest/v1/annotations/hooks/{id}

Turns a JSON payload into a chart annotation for the source's project, environment and type. GitHub sources verify X-Hub-Signature-256 and annotate published releases and successful deployments; generic sources map fields with their template and, when a secret is set, require the x-gamebeast-secret header. Answers 200 for every accepted payload, including skipped ones, so senders don't retry; 401 for a bad signature or secret, 400 when the body isn't JSON.

Path Parameters

id*string

The source id from its URL

Length32 <= length <= 36

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/ingest/v1/annotations/hooks/stringstringstringstringstringst"
{  "status": "created",  "annotationId": "88801ce0-d7fe-4339-afa4-cdb9248204d4",  "reason": "string"}