API Reference

Authorization: Bearer YOUR_API_KEY

X-API-Key: YOUR_API_KEY

POST /calendar/event-types

{
  "title": "Product Demo",
  "slug": "demo",
  "duration": 30,
  "description": "See our product in action",
  "location": {
    "type": "GOOGLE_MEET"
  },
  "scheduleId": "schedule_xxx",
  "bufferBefore": 5,
  "bufferAfter": 10,
  "minimumNotice": 60,
  "maximumAdvance": 60
}

GET /calendar/event-types

GET /calendar/event-types/{eventTypeId}

PATCH /calendar/event-types/{eventTypeId}

DELETE /calendar/event-types/{eventTypeId}

POST /calendar/schedules

{
  "name": "Work Hours",
  "timezone": "America/New_York",
  "isDefault": true,
  "availability": [
    { "day": "MONDAY", "startTime": "09:00", "endTime": "17:00" },
    { "day": "TUESDAY", "startTime": "09:00", "endTime": "17:00" },
    { "day": "WEDNESDAY", "startTime": "09:00", "endTime": "17:00" },
    { "day": "THURSDAY", "startTime": "09:00", "endTime": "17:00" },
    { "day": "FRIDAY", "startTime": "09:00", "endTime": "17:00" }
  ]
}

GET /calendar/schedules

GET /calendar/schedules/{scheduleId}

PATCH /calendar/schedules/{scheduleId}

DELETE /calendar/schedules/{scheduleId}

POST /calendar/schedules/{scheduleId}/overrides

{
  "date": "2024-12-25",
  "isAvailable": false,
  "reason": "Christmas Day"
}

DELETE /calendar/schedules/{scheduleId}/overrides/{overrideId}

GET /calendar/availability

{
  "days": [
    {
      "date": "2024-01-15",
      "slots": [
        { "startTime": "09:00", "endTime": "09:30" },
        { "startTime": "09:30", "endTime": "10:00" }
      ]
    }
  ]
}

POST /calendar/bookings

{
  "eventTypeId": "evt_xxx",
  "startTime": "2024-01-15T10:00:00-05:00",
  "attendee": {
    "name": "John Doe",
    "email": "john@example.com",
    "timezone": "America/New_York"
  },
  "notes": "Looking forward to the meeting",
  "responses": {
    "company": "Acme Corp"
  },
  "metadata": {
    "source": "website"
  }
}

{
  "uid": "booking_xxx",
  "eventTypeId": "evt_xxx",
  "status": "CONFIRMED",
  "startTime": "2024-01-15T15:00:00.000Z",
  "endTime": "2024-01-15T15:30:00.000Z",
  "attendee": {
    "name": "John Doe",
    "email": "john@example.com",
    "timezone": "America/New_York"
  },
  "host": {
    "id": "user_xxx",
    "name": "Jane Smith",
    "email": "jane@company.com"
  },
  "meetingUrl": "https://meet.google.com/xxx",
  "rescheduleUrl": "https://calendar.usetransactional.com/reschedule/xxx",
  "cancelUrl": "https://calendar.usetransactional.com/cancel/xxx"
}

GET /calendar/bookings

GET /calendar/bookings/{bookingUid}

POST /calendar/bookings/{bookingUid}/cancel

{
  "reason": "Schedule conflict",
  "cancelledBy": "attendee",
  "notifyHost": true
}

POST /calendar/bookings/{bookingUid}/reschedule

{
  "startTime": "2024-01-20T14:00:00-05:00",
  "reason": "Need to move to next week",
  "notifyAttendee": true
}

POST /calendar/bookings/{bookingUid}/confirm

POST /calendar/bookings/{bookingUid}/reject

{
  "reason": "Not available at this time"
}

POST /calendar/webhooks

{
  "url": "https://yourapp.com/webhooks/calendar",
  "events": ["booking.created", "booking.cancelled"]
}

GET /calendar/webhooks

GET /calendar/webhooks/{webhookId}

PATCH /calendar/webhooks/{webhookId}

DELETE /calendar/webhooks/{webhookId}

GET /calendar/webhooks/{webhookId}/deliveries

import { Transactional } from '@usetransactional/node';
 
const client = new Transactional({
  apiKey: process.env.TRANSACTIONAL_API_KEY,
});
 
// Event Types
const eventType = await client.calendar.eventTypes.create({ title, slug, duration });
const eventTypes = await client.calendar.eventTypes.list();
await client.calendar.eventTypes.update(id, { title });
await client.calendar.eventTypes.delete(id);
 
// Schedules
const schedule = await client.calendar.schedules.create({ name, timezone, availability });
const schedules = await client.calendar.schedules.list();
await client.calendar.schedules.update(id, { availability });
await client.calendar.schedules.addOverride(id, { date, isAvailable });
 
// Availability
const slots = await client.calendar.availability.get({
  eventTypeId,
  startDate,
  endDate,
});
 
// Bookings
const booking = await client.calendar.bookings.create({
  eventTypeId,
  startTime,
  attendee,
});
const bookings = await client.calendar.bookings.list({ status: 'CONFIRMED' });
await client.calendar.bookings.cancel(uid, { reason });
await client.calendar.bookings.reschedule(uid, { startTime });
 
// Webhooks
const webhook = await client.calendar.webhooks.create({ url, events });

from usetransactional import Transactional
 
client = Transactional(api_key="your_api_key")
 
# Event Types
event_type = client.calendar.event_types.create(title=title, slug=slug, duration=duration)
event_types = client.calendar.event_types.list()
client.calendar.event_types.update(id, title=title)
client.calendar.event_types.delete(id)
 
# Schedules
schedule = client.calendar.schedules.create(
    name=name,
    timezone=timezone,
    availability=availability
)
 
# Availability
slots = client.calendar.availability.get(
    event_type_id=event_type_id,
    start_date=start_date,
    end_date=end_date
)
 
# Bookings
booking = client.calendar.bookings.create(
    event_type_id=event_type_id,
    start_time=start_time,
    attendee=attendee
)
client.calendar.bookings.cancel(uid, reason=reason)
client.calendar.bookings.reschedule(uid, start_time=new_time)
 
# Webhooks
webhook = client.calendar.webhooks.create(url=url, events=events)