Skip to content
Integright

API reference

The Integright API is a RESTful service over HTTPS. Every action available in the dashboard or CLI is available through the API.

Authentication

All requests require a bearer token in the Authorization header. Tokens are scoped per workspace and per environment.

curl https://api.integright.net/v1/pipelines \
  -H "Authorization: Bearer $INTEGRIGHT_TOKEN"

Tokens are issued from Settings → API tokens and can be revoked instantly. They never appear in logs or in our database at rest - hashed before storage, decrypted only in memory.

Base URL

https://api.integright.net/v1

Pipelines

A pipeline is the top-level object that ties a source to a destination with a transform chain.

GET /pipelines

List all pipelines in the workspace.

{
  "data": [
    {
      "id": "pl_01H8ZZ",
      "name": "payments-to-warehouse",
      "status": "active",
      "source_id": "sr_01H8YY",
      "destination_id": "ds_01H8XX",
      "events_last_24h": 2481093
    }
  ]
}

POST /pipelines

Create a new pipeline.

curl -X POST https://api.integright.net/v1/pipelines \
  -H "Authorization: Bearer $INTEGRIGHT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "leads-to-hubspot",
    "source_id": "sr_01H9AA",
    "destination_id": "ds_01H9BB",
    "transform": [{ "rename": { "user_id": "contact_id" } }]
  }'

Events

GET /events

Stream or page events that have flowed through a pipeline.

Query params:

  • pipeline_id - required
  • from / to - RFC 3339 timestamps
  • limit - default 100, max 1000
{
  "data": [
    {
      "id": "ev_01HC1",
      "pipeline_id": "pl_01H8ZZ",
      "ingested_at": "2026-04-16T12:00:03Z",
      "delivered_at": "2026-04-16T12:00:03.119Z",
      "payload": { "amount": 9900, "currency": "USD" }
    }
  ],
  "next_cursor": "eyJwbCI6IjAxSDhaWiJ9"
}

POST /events/replay

Replay an event, or a window of events, into the destination.

{
  "pipeline_id": "pl_01H8ZZ",
  "from": "2026-04-15T00:00:00Z",
  "to": "2026-04-15T01:00:00Z"
}

Rate limits

Default limits:

  • 100 req/s per token
  • 10,000 events/s per pipeline

Exceeded requests return 429 Too Many Requests with a Retry-After header. Enterprise plans can increase limits up to 100,000 events/s per pipeline.

Errors

Errors follow the Problem Details shape:

{
  "type": "https://integright.net/errors/invalid-request",
  "title": "Invalid pipeline config",
  "status": 400,
  "detail": "transform[1].rename: key 'foo' not present in source schema",
  "instance": "/pipelines"
}

SDKs

Official SDKs are available for:

  • TypeScript / JavaScript - @integright/sdk
  • Python - integright
  • Go - github.com/integright/integright-go
  • Ruby - integright gem

Every SDK is generated from the same OpenAPI spec, so feature parity is guaranteed.