Countertop Studio

Quickstart

This guide will help you get set up with Countertop Studio's API, powerful Webhook system with intelligent retry logic, and our n8n integration. We'll cover how to request access, configure your secrets, and make your first API request.

Countertop Studio is currently in the alpha phase. To get access to the API, Webhook system and n8n integration, please reach out to our support team. In the beta phase, you'll be able to create and manage secrets and permissions directly in your account.

Getting Access

During the alpha phase, access to Countertop Studio's API and integrations is by request only. Here's how to get started:

  1. Contact Support - Reach out to our support team to request access to the API, Webhook system, and n8n integration.
  2. Await Approval - Our team will review your request and provide you with access credentials.
  3. Beta Phase - In our upcoming beta phase, you'll be able to self-serve by creating and managing your own secrets and permissions directly in your dashboard.

Security & Permissions

To ensure Countertop Studio remains extremely secure, every integration requires two authentication headers:

  • X-Api-Key - A unique secret for authenticating your requests to the API
  • X-Department-Id - Specifies which department this integration has access to

Permissions are managed per department, which gives you complete flexibility:

  • Create multiple API keys for different integrations or teams
  • Each integration only accesses data within its assigned department
  • Scale across multiple departments with precise permission control
  • Easily revoke or rotate credentials on a per-department basis

You can create as many webhooks and API integrations as needed to connect all your systems.

Integration Options

Countertop Studio offers multiple ways to integrate depending on your needs:

REST API

Build custom integrations using our HTTP API. Authenticate requests using two headers: your API key and the department ID. This allows permissions to be managed on a per-department basis, giving you extremely flexible control over what each integration can access.

POST
/api/v1/integration/customers
curl -X POST https://studio.countertop.app/api/v1/integration/customers \
  -H "X-Api-Key: {your-secret}" \
  -H "X-Department-Id: {department-id}" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
  }'

Per-Department Permissions

Permissions in Countertop Studio are configured on a per-department basis. This means you can:

  • Create multiple API keys for different departments
  • Grant each integration access only to the data and operations it needs within that specific department
  • Scale your integrations across multiple departments with fine-grained control

This architecture ensures maximum flexibility while maintaining the highest security standards.

Webhooks

Webhooks allow your applications to receive real-time events from Countertop Studio whenever important changes occur in your workspace.

Instead of repeatedly polling the API for updates, Countertop Studio will send an HTTP request to your configured endpoint whenever an event happens.

Typical use cases include:

  • reacting to newly created customers
  • tracking deal updates
  • triggering external workflows
  • syncing data with third-party systems

Coming Soon

Our webhook system is currently being finalized and will be available soon.

The upcoming webhook documentation will include:

  • how to register webhook endpoints
  • a list of available event types
  • payload formats for each event
  • security verification for webhook requests
  • details about our retry logic and delivery guarantees

n8n Integration

Use our n8n addon to build complex automation workflows without writing code. Connect Countertop Studio with hundreds of other applications and services through n8n's visual workflow builder.

Learn more about the n8n addon

What's next?

Great! You're ready to start integrating with Countertop Studio. Here are some helpful resources to guide you further: