Sources

Installnpm install @chronicle-labs/sdk

SDK generation in progress - until published, Node 18+ fetch works with no extra dependencies.

Endpoints

Method	Path	Status
`POST`	`/v1/sources`	Beta
`GET`	`/v1/sources`	Beta
`GET`	`/v1/sources/{id}`	Beta
`GET`	`/v1/sources/{id}/catalog`	Beta

Register a source

Register a custom source so Chronicle can receive webhooks for it and categorize ingested events. The source ID you choose becomes the webhook path segment and the value you pass as source when ingesting events.

tenant_idstringrequired

Tenant namespace. The source is scoped to this tenant.

idstringrequired

Unique slug for the source (lowercase, no spaces). Used in webhook URL and event source field.

namestringrequired

Human-readable display name.

descriptionstring

Short description of what this source provides.

webhook_secretstring

Signing secret for verifying inbound webhooks. If omitted, signature verification is skipped.

signature_schemeenum

One of "hmac-sha1" or "hmac-sha256". Defaults to "hmac-sha256".

event_typesobject[]

Pre-declare event types this source will emit. Each object has event_type, description, and category.

Node

const source = await chronicle.sources.create({
  tenant_id: "tenant_demo",
  id: "my_crm",
  name: "My CRM",
  description: "Internal CRM system events",
  webhook_secret: "whsec_abc123",
  signature_scheme: "hmac-sha256",
  event_types: [
    { event_type: "crm.contact_created", description: "New contact added", category: "contact" },
    { event_type: "crm.deal_closed", description: "Deal moved to closed-won", category: "deal" },
  ],
});

Response

JSON

{
  "id": "my_crm",
  "tenant_id": "tenant_demo",
  "name": "My CRM",
  "description": "Internal CRM system events",
  "version": "1.0.0",
  "capabilities": { "webhook": true },
  "webhook_url": "https://api.chronicle-labs.dev/v1/webhooks/my_crm",
  "event_types_count": 2
}

List sources

Returns all registered source adapters for a tenant.

tenant_idstringrequired

Tenant namespace.

limitinteger

Max sources to return (default 25, max 1000).

offsetinteger

Number of results to skip (default 0).

Node

const sources = await chronicle.sources.list({ tenant_id: "tenant_demo" });

Response

JSON

{
  "sources": [
    { "id": "intercom", "name": "Intercom", "description": "Intercom conversation events", "version": "1.0.0", "capabilities": { "webhook": true } }
  ],
  "count": 1,
  "has_more": false
}

Retrieve a source

Fetch full details for a single source including its manifest and capabilities.

tenant_idstringrequired

Tenant namespace (query param).

Node

const source = await chronicle.sources.retrieve("intercom", { tenant_id: "tenant_demo" });

Response

JSON

{
  "manifest": {
    "id": "intercom",
    "name": "Intercom",
    "description": "Intercom conversation events",
    "version": "1.0.0",
    "capabilities": { "webhook": true },
    "event_catalog": []
  }
}

Get source catalog

Returns event types Chronicle understands for a source, with PII field metadata.

tenant_idstringrequired

Tenant namespace (query param).

Node

const catalog = await chronicle.sources.catalog("intercom", { tenant_id: "tenant_demo" });

Response

JSON

{
  "source_id": "intercom",
  "events": [
    { "event_type": "support.message.customer", "source_topic": "conversation.user.created", "description": "Customer sent a message", "category": "message", "pii_fields": ["payload.body"] }
  ]
}