Skip to content
Starlite Docs

Integration API Examples

OpenAPI schema

We provide a full OpenAPI schema here.

API endpoint

The endpoint used for all calls is https://integration.starlite.systems.

The path used for all calls is /event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}.

Timestamps

For all timestamps the required format is the Unix timestamp (10 or 13 digits as a string).

Records

Records can be updated if they are in an automated lifecycle.

The following is a simple example:

Terminal window
curl -X POST -d '{
  "id": "my_record_id",
  "organizationId": "my_org_id",
  "lifecycleManagement": "manual",
  "spec": {
    "repo": "someorg/somerepo",
    "name": "my-api",
    "description": "My API is awesome",
    "kind": "api",
    "lifecycleStage": "beta",
    "version": "1.0.0",
    "contacts": [
      {
        "email": "[email protected]",
        "relation": "Service Owner"
      }
    ],
    "baseline": {
      "id": "your_baseline_id"
    },
    "team": "ThatAwesomeTeam",
    "system": "some-system",
    "domain": "some-domain",
    "dataSensitivity": "public",
    "tags": [
      "typescript",
      "backend"
    ]
  },
  "relations": [
    "my-other-service"
  ],
  "support": {
    "resolverGroup": "ThatAwesomeTeam"
  },
  "slo": [
    {
      "description": "Max latency must be 350ms for the 90th percentile",
      "type": "latency",
      "implementation": "(sum:trace.aws.lambda.hits.by_http_status{http.status_class:2xx AND service IN (demoservice-user,demoservice-greet)} by {service}.as_count() - sum:trace.aws.lambda.errors.by_http_status{http.status_class:5xx AND service IN (demoservice-user,demoservice-greet)} by {service}.as_count()) / (sum:trace.aws.lambda.hits{service IN (demoservice-user,demoservice-greet)} by {service}.as_count())",
      "target": "350ms",
      "period": 30
    }
  ],
  "api": [
    {
      "name": "My API",
      "schemaPath": "./api/schema.yml"
    }
  ],
  "metadata": {},
  "links": [
    {
      "url": "https://my-confluence.atlassian.net/wiki/spaces/DEV/pages/123456789/",
      "title": "Confluence documentation",
      "icon": "documentation"
    }
  ]
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Standards

The input is a StandardLint result which you get by running StandardLint, an open source Node.js package. You also need a standardlint.json file with your checks. Please refer to their documentation for more on this.

In summary, to generate this input you should have StandardLint installed and run it prior to calling the Integration API.

A call might look like this:

Terminal window
curl -X POST -d '{
  "passes": 20,
  "warnings": 2,
  "failures": 1,
  "results": [
    {
      "message": "Some message",
      "name": "ResultName",
      "path": "filename.md",
      "status": "pass"
    }
  ]
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Metrics

Change

The timestamp can be omitted, in which case the current system time will be used.

Terminal window
curl -X POST -d '{
  "event": "change",
  "commitSha": "cf1d3df5ea4373e69d8adc3808e9f8ce23b61360",
  "timestamp": "1732802071"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Deployment

The timestamp can be omitted, in which case the current system time will be used.

Terminal window
curl -X POST -d '{
  "event": "deployment",
  "commitSha": "cf1d3df5ea4373e69d8adc3808e9f8ce23b61360"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Incident opened

This tracks the issue being opened.

Terminal window
curl -X POST -d '{
  "event": "incident-opened",
  "id": "abc123",
  "createdAt": "1732718640"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Incident resolved

Terminal window
curl -X POST -d '{
  "event": "incident-resolved",
  "id": "abc123",
  "createdAt": "1732718640",
  "resolvedAt": "1732718800"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Comment

Terminal window
curl -X POST -d '{
  "event": "comment"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Review approved

Terminal window
curl -X POST -d '{
  "event": "review-approved",
  "createdAt": "1732802071",
  "submittedAt": "1733000000"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Review changes requested

Terminal window
curl -X POST -d '{
  "event": "review-changes",
  "createdAt": "1732802071",
  "submittedAt": "1733000000"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Pull request opened

Terminal window
curl -X POST -d '{
  "event": "pr-opened",
  "additions": 5,
  "changedFiles": 3,
  "deletions": 2
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Pull request closed

Terminal window
curl -X POST -d '{
  "event": "pr-closed",
  "createdAt": "1732802071",
  "closedAt": "1732809000"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}

Pull request merged

Terminal window
curl -X POST -d '{
  "event": "pr-merged",
  "createdAt": "1732802071",
  "mergedAt": "1732809000"
}' https://integration.starlite.systems/event/{ORG_ID}/{RECORD_ID}/{WEBHOOK_TOKEN}