Configuración básica
Puedes instalar la integración de Calendly desde nuestro Marketplace. Una vez instalada, podrás consultar disponibilidad, listar eventos agendados, crear enlaces de reserva y cancelar citas directamente desde tu agente.
Prerrequisitos
Antes de usar esta integración, necesitas:
- Cuenta activa en Calendly — Regístrate en calendly.com
- API Key de Calendly — Genera tu token en Calendly Integrations
- Al menos un tipo de evento configurado — Crea tus tipos de reunión en el dashboard de Calendly
Credenciales requeridas
| Campo | Descripción | Requerido |
|---|
| API Key | Token de acceso personal de Calendly | Sí |
Funcionalidades
Obtener usuario actual
Obtiene la información del usuario autenticado, incluyendo su URI (necesario para otras operaciones), nombre, email y zona horaria.
Inputs:
- Sin parámetros requeridos.
Ejemplo:
Listar tipos de evento
Lista todos los tipos de evento (tipos de reunión) configurados por el usuario.
Inputs:
- active (opcional, boolean) — Filtrar por estado activo.
- count (opcional, number) — Cantidad de resultados (1-100).
- page_token (opcional, string) — Token de paginación.
Ejemplo:
{
"active": true,
"count": 20
}
Obtener tipo de evento
Obtiene información detallada de un tipo de evento específico.
Inputs:
- event_type_uri (string) — URI del tipo de evento.
Ejemplo:
{
"event_type_uri": "https://api.calendly.com/event_types/ABC123"
}
Listar eventos agendados
Lista los eventos (reuniones) agendados con filtros opcionales por fecha, estado o invitado.
Inputs:
- min_start_time (opcional, string) — Fecha mínima en formato ISO 8601.
- max_start_time (opcional, string) — Fecha máxima en formato ISO 8601.
- status (opcional, enum:
active | canceled) — Estado del evento.
- invitee_email (opcional, string) — Filtrar por email del invitado.
- count (opcional, number) — Cantidad de resultados (1-100).
- page_token (opcional, string) — Token de paginación.
Ejemplo:
{
"min_start_time": "2025-01-01T00:00:00Z",
"max_start_time": "2025-01-31T23:59:59Z",
"status": "active"
}
Obtener evento agendado
Obtiene información detallada de un evento específico, incluyendo invitados y sus respuestas.
Inputs:
- event_uri (string) — URI del evento agendado.
Ejemplo:
{
"event_uri": "https://api.calendly.com/scheduled_events/XYZ789"
}
Consultar disponibilidad
Obtiene los horarios disponibles para un tipo de evento en un rango de fechas.
Inputs:
- event_type_uri (string) — URI del tipo de evento.
- start_time (string) — Inicio del rango en formato ISO 8601 UTC.
- end_time (string) — Fin del rango en formato ISO 8601 UTC.
- timezone (opcional, string) — Zona horaria IANA (ej. “America/Guayaquil”).
Ejemplo:
{
"event_type_uri": "https://api.calendly.com/event_types/ABC123",
"start_time": "2025-01-15T00:00:00Z",
"end_time": "2025-01-16T00:00:00Z",
"timezone": "America/Guayaquil"
}
Crear enlace de agendamiento
Crea un enlace para agendar reuniones de un tipo de evento específico.
Inputs:
- event_type_uri (string) — URI del tipo de evento.
- max_event_count (opcional, number) — Máximo de reservas permitidas con este enlace.
Ejemplo:
{
"event_type_uri": "https://api.calendly.com/event_types/ABC123",
"max_event_count": 5
}
Crear enlace de un solo uso
Crea un enlace de agendamiento que solo puede usarse una vez. Opcionalmente pre-llena el email y nombre del invitado.
Inputs:
- event_type_uri (string) — URI del tipo de evento.
- invitee_email (opcional, string) — Email para pre-llenar.
- invitee_name (opcional, string) — Nombre para pre-llenar.
Ejemplo:
{
"event_type_uri": "https://api.calendly.com/event_types/ABC123",
"invitee_email": "[email protected]",
"invitee_name": "Juan Pérez"
}
Cancelar evento
Cancela un evento agendado. Notifica automáticamente a todos los invitados.
Esta acción notificará a todos los participantes que el evento ha sido cancelado.
Inputs:
- event_uri (string) — URI del evento a cancelar.
- reason (opcional, string) — Motivo de la cancelación.
Ejemplo:
{
"event_uri": "https://api.calendly.com/scheduled_events/XYZ789",
"reason": "Reprogramación solicitada por el cliente"
}