Developer Documentation

Build custom integrations with the Supercal REST API and webhooks.

View on GitHub

Quick Start

1

Authentication

Generate an API key from your dashboard

curl -H "Authorization: Bearer YOUR_API_KEY"   https://api.supercal.cc/v1/events
2

Create Event Type

Define a new bookable event type

curl -X POST https://api.supercal.cc/v1/events   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "title": "30 Minute Meeting",
    "duration": 30,
    "description": "A quick 30 minute call"
  }'
3

Fetch Availability

Get available time slots for booking

curl https://api.supercal.cc/v1/availability   -H "Authorization: Bearer YOUR_API_KEY"   -d "event_id=EVENT_ID&date=2024-12-15"
4

Create Booking

Book a time slot

curl -X POST https://api.supercal.cc/v1/bookings   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "event_id": "EVENT_ID",
    "start_time": "2024-12-15T10:00:00Z",
    "attendee_email": "client@example.com",
    "attendee_name": "John Doe"
  }'

API Endpoints

MethodEndpointDescription
GET/api/v1/eventsList all event types
POST/api/v1/eventsCreate a new event type
GET/api/v1/bookingsList all bookings
POST/api/v1/bookingsCreate a new booking
DELETE/api/v1/bookings/:idCancel a booking
GET/api/v1/availabilityGet availability for a user

Webhook Events

Subscribe to events and trigger custom workflows

booking.created

Triggered when a new booking is created

booking.cancelled

Triggered when a booking is cancelled

booking.rescheduled

Triggered when a booking is rescheduled

booking.confirmed

Triggered when a booking is confirmed

booking.completed

Triggered when a booking is completed

poll.created

Triggered when a meeting poll is created

poll.voted

Triggered when someone votes on a poll

poll.finalized

Triggered when a poll is finalized

Webhook Configuration

curl -X POST https://api.supercal.cc/v1/webhooks   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "url": "https://your-app.com/webhook",
    "events": ["booking.created", "booking.cancelled"]
  }'

Need help with integration?

Contact us for developer support, custom integrations, or enterprise API needs.

Contact Support