# Baseline

> Stateful local emulators of 32 third-party APIs, tested with each vendor's official SDK. For CI and no-network sandboxes.

- [Getting started](https://docs.deploybaseline.com/index.md): Run stateful emulators of 28 third-party APIs on your machine, and point your app and its official SDKs at them.
- [Coming from emulate](https://docs.deploybaseline.com/coming-from-emulate.md): Every name that changed when emulate became Baseline, in one place.
- [Configuration](https://docs.deploybaseline.com/configuration.md): The config file, tokens, shared identities, ports, faults, and the control API: settings every provider shares.
- [Saved state](https://docs.deploybaseline.com/state.md): Keep emulator data, tokens, and webhooks across restarts, and save named snapshots to go back to.
- [Provider versions](https://docs.deploybaseline.com/provider-versions.md): Where each built-in service's provider comes from, how baseline.lock pins it, and how to run without a network.
- [Programmatic API](https://docs.deploybaseline.com/programmatic-api.md): Start any emulator from your tests with createEmulator, or import a provider package directly.
- [Custom emulators](https://docs.deploybaseline.com/custom-emulators.md): Define an emulator for any third-party API in TypeScript, run it next to the built-in providers, and share it as a package.
- [GraphQL](https://docs.deploybaseline.com/graphql.md): Serve a GraphQL API from a custom emulator with @deploybaseline/graphql
- [Provider packages](https://docs.deploybaseline.com/provider-authors.md): Publish an emulator as an npm package that the CLI runs in its own process, and run packages other people publish.
- [Authentication](https://docs.deploybaseline.com/authentication.md): How every emulator accepts credentials, and the credential each provider's SDK sends.
- [API reference](https://docs.deploybaseline.com/api-reference.md): Browse every route the emulators you started serve, and send requests to them, at /docs on your machine.
- [Architecture](https://docs.deploybaseline.com/architecture.md): How the packages fit together: the core server and store, one plugin per provider, and shared middleware.
- [WebSockets](https://docs.deploybaseline.com/websockets.md): Which runtimes serve WebSocket endpoints and what the kit provides
- [Official emulators](https://docs.deploybaseline.com/official-emulators.md): Run Firebase, Azure Blob Storage, and Google Cloud Pub/Sub through their vendors' local emulators next to Baseline
- [Providers](https://docs.deploybaseline.com/providers.md): Every built-in emulator, grouped by what it does.
- [Auth0](https://docs.deploybaseline.com/auth0.md): Universal Login, OAuth and OIDC, Management API, role-based access control.
- [Clerk](https://docs.deploybaseline.com/clerk.md): Frontend API, Backend API, OAuth and OIDC, organizations, sessions, JWT templates.
- [Okta](https://docs.deploybaseline.com/okta.md): OAuth 2.0 and OIDC, authorization servers, users, groups, apps.
- [Apple](https://docs.deploybaseline.com/apple.md): Sign in with Apple: authorization, client secrets, ID tokens, server-to-server notifications.
- [Google](https://docs.deploybaseline.com/google.md): OAuth 2.0 and OIDC, Gmail, Calendar, Drive, Sheets, Docs.
- [Microsoft](https://docs.deploybaseline.com/microsoft.md): Entra ID OAuth 2.0 and OIDC, Microsoft Graph: Outlook mail, calendar, contacts, To Do, users and groups, and SharePoint Online and OneDrive over Graph and the SharePoint REST API.
- [Notion](https://docs.deploybaseline.com/notion.md): Pages, databases and data sources, queries, search, blocks, comments, OAuth, webhooks.
- [Slack](https://docs.deploybaseline.com/slack.md): Web API, OAuth v2, incoming webhooks, interactivity, events, and Socket Mode.
- [Discord](https://docs.deploybaseline.com/discord.md): Bot REST API, Gateway over WebSocket, interactions, OAuth2, and rate limits.
- [Twilio](https://docs.deploybaseline.com/twilio.md): Programmable Messaging, Messaging Services, Verify, Voice, and Conversations.
- [WhatsApp](https://docs.deploybaseline.com/whatsapp.md): Cloud API messages, templates, media, phone numbers and accounts, and webhooks.
- [Resend](https://docs.deploybaseline.com/resend.md): Emails, idempotency, domains, API keys, audiences and contacts, and a local inbox.
- [SendGrid](https://docs.deploybaseline.com/sendgrid.md): Mail Send, scheduling, templates, API keys, Marketing, Event Webhook, and a local inbox.
- [Stripe](https://docs.deploybaseline.com/stripe.md): Customers, Payment and Setup Intents, charges, refunds, subscriptions, invoices, Checkout, Connect, and webhooks.
- [PayPal](https://docs.deploybaseline.com/paypal.md): Orders v2, a hosted approval page, Payments v2, and webhooks.
- [Square](https://docs.deploybaseline.com/square.md): Payments, refunds, orders, customers, catalog, locations, OAuth, and webhooks.
- [Plaid](https://docs.deploybaseline.com/plaid.md): Link, items and accounts, transactions, institutions, sandbox helpers, and webhooks.
- [Shopify](https://docs.deploybaseline.com/shopify.md): Admin GraphQL API, OAuth, and webhooks.
- [GitHub](https://docs.deploybaseline.com/github.md): REST and GraphQL: repositories, issues, pull requests, organizations, webhooks, Actions, Checks, OAuth Apps, and GitHub Apps.
- [Linear](https://docs.deploybaseline.com/linear.md): GraphQL API, OAuth, and webhooks.
- [Jira](https://docs.deploybaseline.com/jira.md): The REST API, JQL search, Agile boards and sprints, OAuth 2.0 (3LO), and webhooks.
- [Salesforce](https://docs.deploybaseline.com/salesforce.md): Records, SOQL, describe, sObject collections, composite requests, and OAuth.
- [HubSpot](https://docs.deploybaseline.com/hubspot.md): CRM objects, search, associations, properties, pipelines, owners, OAuth, and webhooks.
- [Zendesk](https://docs.deploybaseline.com/zendesk.md): Tickets, comments, users, organizations and groups, search, views, triggers, OAuth, and webhooks.
- [ServiceNow](https://docs.deploybaseline.com/servicenow.md): The Table API, Attachment API, and Aggregate API.
- [NetSuite](https://docs.deploybaseline.com/netsuite.md): Records, transforms, SuiteQL, custom fields and records, metadata, and OAuth 2.0.
- [QuickBooks](https://docs.deploybaseline.com/quickbooks.md): Accounting entities, queries, batch, change data capture, OAuth 2.0, and webhooks.
- [Xero](https://docs.deploybaseline.com/xero.md): Accounting API, OAuth 2.0 and OpenID Connect, and webhooks.
- [Contributing overview](https://docs.deploybaseline.com/contributing/overview.md): How the Baseline monorepo is laid out, the house rules every change follows, and where to go next.
- [Local development](https://docs.deploybaseline.com/contributing/local-development.md): Set up the toolchain, build the workspace, run emulators from source, and fix the usual snags.
- [Architecture](https://docs.deploybaseline.com/contributing/architecture.md): How a request travels through Baseline: registry, manifests, plugins, store, webhooks, composed services, and the shared UI.
- [Adding a provider](https://docs.deploybaseline.com/contributing/adding-a-provider.md): Scaffold a new emulator package, wire it into the CLI, and meet the provider definition of done.
- [Testing and conformance](https://docs.deploybaseline.com/contributing/testing-and-conformance.md): The kinds of tests Baseline runs, the gates that keep providers honest, how to run each one, and what CI enforces.
- [Docs and API reference](https://docs.deploybaseline.com/contributing/docs-and-api-reference.md): Where Baseline's documentation lives, what is generated from code, how vendored specs are pinned, and how to preview changes.
- [Releasing](https://docs.deploybaseline.com/contributing/releasing.md): How version bumps in one pull request become npm packages and GitHub releases.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.