Skip to main content

​
Signals API

Send service deployments, alerts, and custom events to help Codewolf correlate issues across your stack.

​
Base URL

https://signals.codewolf.app/{signalKey}

​
Authentication

All API requests require Bearer token authentication: 
Authorization: Bearer YOUR_API_KEY
You can find your signal key and API key in the Codewolf dashboard.

​
Event Types

Send deployment events, alerts, and change notifications from:
  • GitHub Actions
  • Jenkins
  • ArgoCD
  • GitLab CI
  • CircleCI
  • Any CI/CD or deployment tool

​
Example: Deployment Event

Send a deployment event from GitHub Actions: 
curl -X POST https://signals.codewolf.app/{signalKey} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "deployment",
    "repository": "${{ github.repository }}",
    "service": "api-service",
    "version": "${{ github.sha }}",
    "sha": "${{ github.sha }}",
    "environment": "production",
    "triggeredBy": "${{ github.actor }}",
    "status": "success",
    "timestamp": "'$(date -u +%Y-%m-%dT%H:%M:%SZ)'",
    "metadata": {
      "workflow": "${{ github.workflow }}",
      "runId": "${{ github.run_id }}",
      "runNumber": "${{ github.run_number }}"
    }
  }'