Skip to main content

Application Setup Guide

Prerequisites & Account Setup​

Before creating your application, ensure you are logged into your Mobiscroll account.

Head over to the pricing page and choose the plan that suits you the best. After your subscription is started, the Mobiscroll Connect dashboard will become available.

info

This guide assumes your initial Mobiscroll account setup is already complete. If you have not yet set up your Mobiscroll account, please finalize your profile registration before proceeding.

Creating the First Application​

To use Mobiscroll Connect services, you must register your application to generate the necessary API credentials.

  1. Navigate to the Connect dashboard tab on your account page.
  2. Click the Create new app.
  3. You will be prompted to fill in the project details:
  • Application Name: An internal, descriptive name for your application (e.g., "My Scheduling App"). This is not shown to your users.
  • Display Name (Optional): The public name shown to your users on the Connect authorization and connection-management screens. When set, the screens read "<Display Name> is using Mobiscroll Connect ..." and the return button reads "Back to <Display Name>", so users always know which app they are connecting to and where they will return. When left empty, a generic wording ("The application ...") is used instead.
  • Redirect URI (Callback URL): The URL where users will be redirected after successfully authorizing with a provider. This must match the route in your application that handles the OAuth callback.
  • Webhook URL (Optional): If you plan to use webhooks for event notifications, provide the endpoint URL where Mobiscroll Connect can send these updates. See Webhooks API for subscription and payload details.
  1. Click Create application to finalize the application setup.
info

Both the Application Name and Display Name can be changed later from the Settings menu of your application.

Retrieving Client Credentials​

Once your application is created, you need to retrieve the credentials required to authenticate your client with the Mobiscroll Connect service.

  1. Navigate to the Settings left menu item of your newly created application.

  2. Locate the API Credentials section.

  3. Client ID: Copy the string displayed in the Client ID field. This is your public identifier.

    What is a Client ID?

    The Client ID is a unique, public identifier for your application. It is used by Mobiscroll Connect to recognize which app is making a request. You can safely share your Client ID in client-side code or with users.

  4. Client secret: Click Show to reveal or copy the Client secret.

    What is a Client Secret?

    The Client secret is a confidential string used to prove your application's identity to Mobiscroll Connect. It must be kept private and only used in server-side code. Never expose it in public repositories or client-side code.

info

The Client secret is vital for the authentication flow. Ensure you copy it now, as you will need it to configure your environment in the next step.

Configuring the Client Application​

With your Client ID and Client Secret secured, you are ready to configure your application to communicate with Mobiscroll Connect.

Create or update a .env file in the root of your project (Node.js, Python, etc.) to store these credentials securely.

.env
# Your Mobiscroll Connect Credentials
MOBISCROLL_CONNECT_CLIENT_ID=proj-123456...
MOBISCROLL_CONNECT_CLIENT_SECRET=secret-xyz789...
Security Note

Never expose your MOBISCROLL_CONNECT_CLIENT_SECRET in client-side code (browsers, mobile apps, or public repositories). This secret should only be used in server-side environments to exchange authorization codes for access tokens.

Verifying the Integration​

To validate that your credentials are correct and the connection is established, you can perform a "Hello World" connection test by manually constructing an authorization URL that matches the integration code sample.

Step 1: Construct the URL:

https://connect.mobiscroll.com/api/oauth/authorize?response_type=code&client_id=${MOBISCROLL_CONNECT_CLIENT_ID}&user_id=test-user-1&scope=read-write

Parameter notes:

  • user_id is the unique identifier of a user in your system.
  • scope defines the level of access requested (e.g., read-write for full calendar access). For more details, see scopes.

Step 2: Paste this URL into your browser.

Validation Results:

  • Success: If your browser redirects you to the Provider Selection page (or a login screen for Google/Outlook), your client_id is recognized, and the service is reachable.
  • Failure: If you receive a JSON response stating 401 Unauthorized or Invalid Client, double-check the credentials in your .env file and ensure the client_id matches exactly what is in your dashboard.

Next Steps​

Now that your credentials are verified and the connection is established, you can proceed with integrating Mobiscroll Connect into your application. Choose the approach that best fits your workflow:

Explore the API (no code required)​

Before writing any integration code, use the Postman collection to run the full OAuth flow, inspect real API responses, and get familiar with the available endpoints. This is the fastest way to understand how Mobiscroll Connect works and to validate your credentials end to end.

Get started with the Postman Collection

REST API Integration​

Build your integration directly using HTTP requests to the Mobiscroll Connect API endpoints. This approach gives you full control and flexibility.

Get started with REST API Integration

Node.js SDK​

Use the official Node.js SDK for a streamlined integration experience. The SDK provides typed methods, automatic token management, and simplified error handling.

Get started with the Node.js SDK

PHP SDK​

Use the official PHP SDK for backend integrations in PHP applications. The SDK provides resource-based API access, typed models, and consistent exception handling.

Get started with the PHP SDK

.NET SDK​

Use the official .NET SDK for backend integrations in .NET 6+ applications. The SDK runs on .NET Core and provides async methods, typed models, and consistent exception handling.

Get started with the .NET SDK

Python SDK​

Use the official Python SDK for backend integrations in Python 3.9+ applications. The SDK provides both sync and async clients, typed models, automatic token management, and consistent exception handling.

Get started with the Python SDK

Demo Application​

Start with our complete working example that demonstrates the full OAuth flow, calendar synchronization, and event management using the Node.js SDK out of the box.

View the Demo App on GitHub