Documentation

Documentation

An overview of how LithicApp works: events, workflows, webhooks, and environments.

Overview

LithicApp lets you create workflows that run when events happen in your applications. You send events to LithicApp through the API, and workflows decide what happens next: syncing data to another system, notifying your team, or calling your own endpoints with a webhook.

All communication with LithicApp uses HTTPS and JSON.

Core concepts

ConceptWhat it is
EventSomething that happened in your application, such as a new customer record. Events start workflows.
WorkflowA trigger, optional conditions, and one or more actions that run automatically.
ActionA step in a workflow, such as syncing data, transforming fields, notifying a team, or sending a webhook.
IntegrationA saved connection to a system your workflows send data to.
RunOne execution of a workflow, recorded with its input and the result of each step.

Environments

EnvironmentPurpose
SandboxBuild and test integrations with test events.
ProductionRun live workflows for your applications.

Each environment has its own credentials and configuration, so testing never affects production.

Authentication

API requests are authenticated with secret API keys. Keys belong to a single environment and can be rotated or revoked at any time.

Keep keys secret. Never expose secret keys in client-side code or public repositories. Rotate a key immediately if you believe it has been exposed.

Workflows

A workflow is made of three parts:

  • Trigger: the event type that starts the workflow, for example customer.created.
  • Conditions (optional): rules that must be true for the workflow to continue.
  • Actions: steps executed in order, such as syncing data, transforming fields, notifying a team, or sending a webhook.

Every run is recorded and visible in the dashboard, so you can see exactly what happened and when.

Webhooks

Register an HTTPS endpoint and choose the events to subscribe to. LithicApp sends a request to your endpoint when a matching event occurs. Respond with a 2xx status to acknowledge receipt. Every delivery is visible in the dashboard.

Example

The workflow below runs whenever a customer.created event arrives. It syncs the record to a CRM and notifies the team.

example.ts
const workflow = await platform.workflows.create({
  name: "customer-onboarding",
  trigger: {
    event: "customer.created"
  },
  actions: [
    {
      type: "sync",
      destination: "crm"
    },
    {
      type: "notify",
      destination: "team"
    }
  ]
});

Illustrative example.

Getting access

The full API reference, credentials, and sandbox access are provided when your workspace is set up. To get started, contact our team or email info@lithicapp.com.