Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.costory.io/llms.txt

Use this file to discover all available pages before exploring further.

Post build and deploy events directly from your pipelines using a simple curl call.

​
Example: curl from a CI / CD pipeline

curl -X POST "https://app-api.costory.io/events" \
  -H "Authorization: Bearer $COSTORY_EVENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Deploy complete",
    "timestamp": "2026-03-04T14:25:00Z",
    "category": "TECHNICAL",
    "source": "ci-cd",
    "environment": "prod",
    "service": "api",
    "labels": ["release", "backend"],
    "metadata": {
      "commit": "1b2c3d4",
      "pipeline": "github-actions",
      "url": "https://github.com/acme/api/actions/runs/123"
    }
  }'
FieldRequiredDescription
nameYesEvent title shown in the timeline.
timestampYesISO-8601 UTC timestamp for the event.
categoryYesBUSINESS, TECHNICAL, or PROVIDER.
sourceYesA short identifier like custom, ci-cd, or github.
environmentNoprod, staging, or another environment label.
serviceNoService or application name.
labelsNoReusable tags for filtering in Costory.
metadataNoJSON object with URLs, commit SHAs, or context.
Use consistent labels and environments so filters work across teams. For example: prod, staging, api, frontend.
Last modified on March 18, 2026