Home Uncategorized

Configuring Custom Integrations with Schedly API

Last updated on Jun 23, 2026

Overview

Schedly's powerful API allows developers to integrate scheduling capabilities into their own apps, enhancing user experience and productivity. The API provides access to create, edit, and manage event types, along with handling authentication and user management via secure protocols like SAML/OIDC.

Prerequisites

  • Access to a Schedly account with API permissions enabled.
  • Knowledge of authentication protocols such as SAML or OIDC, if applicable.
  • Familiarity with RESTful API concepts.

Step-by-Step Instructions

Access API Endpoints

  1. Log in to your Schedly account.
  2. Navigate to Settings > API & Developer Tools.
  3. Review available API endpoints for managing events, users, and authentication within the Schedly system:
    • Event Types: /api/event_types
    • Authentication: /api/auth
    • User Management: /api/users

How to Authenticate API Requests

  1. Choose your authentication method from SAML/OIDC, password, or magic link.
  2. For OAuth via SAML/OIDC:
    • Get the client ID and secret from the Settings > Integrations page.
    • Follow the OAuth flow to obtain a token.
  3. For email/password authentication:
    • Use your login credentials to generate an access token by POSTing to /api/auth/login.
  4. Include the token in the header of your requests: Authorization: Bearer {token}.

Examples of Common API Use Cases

Creating a New Event Type via API

  1. Make a POST request to /api/event_types with the required fields:

    { "name": "Team Meeting", "description": "Monthly review", "duration": 60, "seats": 10, "hidden": false }

    • Ensure you include Requires confirmation if needed.

Fetching Event Types

  1. Send a GET request to /api/event_types to retrieve all configured events.
    • This will return JSON detailing each event type.

Best Practices for API Integration

  1. Always secure your API keys and tokens. Store them in environment variables or a secure vault.
  2. Implement error handling for all API calls to gracefully manage downtime or rate limits.
  3. Make use of Schedly's webhook notifications for real-time updates instead of polling the API.
  4. Test your integration in a development environment before deploying it to production.

Key Details & Limits

  • API requests are limited to 1000 per hour per account.
  • Supported authentication methods: SAML/OIDC, email/password, magic link.
  • Event durations can range from 15 to 120 minutes.
  • All endpoints return JSON responses.
  • For enterprise-level integration, custom requirements may apply.

Frequently Asked Questions

  1. How can I reset my API token?
    • You can regenerate an API token by navigating to Settings > API & Developer Tools > Regenerate API Key.
  2. Can I access user data via the API?
    • Yes, with the appropriate permissions, you can use the /api/users endpoint to manage user data.
  3. What happens if I exceed the API rate limit?
    • Excess calls will return a 429 error. You must wait an hour before resuming requests.
  4. How do I test API requests?
    • Use tools like Postman to simulate requests in a controlled environment.
  5. Is the API compatible with third-party automatic deployment tools?
    • Yes, integrate our API with your CI/CD pipeline ensuring security compliance.

Troubleshooting

  • Authentication Failed: Double-check your token expiry and permissions.
  • API Call Returning 404: Check the endpoint URL and any required parameters.
  • Data Not Updating: Confirm that webhooks are set up correctly for real-time synchronization.

Related Topics

  • Using SAML/OIDC Integrations: Learn how to set up SSO with SAML/OIDC.
  • Managing Event Types: Step-by-step guide for configuring events through Schedly UI.
  • Account Security Best Practices: Keep your API integrations secure and compliant.