Getting Started with the Conversational Connect Developer Portal Getting Started with the Conversational Connect Developer Portal

Getting Started with the Conversational Connect Developer Portal

Jai Theerth

Objective

This user manual provides step-by-step guidance on using the Conversational Connect Developer Portal, covering application management, API usage, analytics monitoring, and settings configuration.

Applies To

  • Conversational Connect (Jumper.ai)
  • Jumper.ai
  • API
  • Customers
  • Send Message (Channels: SMS, RCS, WhatsApp)
  • Analytics

Prerequisites

Before using the Conversational Connect Developer Portal, ensure that:

  • You have an active Conversational Connect (Jumper.ai) account.
  • You have connected the channel with Conversational Connect (Jumper.ai) 
  • You have the required permissions to view and manage the developers module.
     

Quick Navigation


Developer Portal – Sections Overview

The Developer Portal  includes the following sections:

  • Applications: Create and manage applications.
  • API Reference: Explore and test APIs.
  • Analytics: Monitor application traffic and usage.
  • Settings: Configure Webhooks and Webhook authentication.

APPLICATIONS

Create a new application

  1. Navigate to Developer Portal → Applications



 

  1. Click + Create a New Application.

  1. Enter the following details: Application name, Application description, and Enable required capabilities.

  1. Save the application 

5. A new application will be created and displayed in the Applications list.

Search Applications

The user can search applications using:

  • Application Name
  • Application ID
  • Description
  • Created By

Application Actions

Each application supports the following actions: Revoke, Activate, Delete, and View Details.

Revoke Application
  • Click the Revoke button

  • Confirm the action to revoke the application.

  •  Once activated, the application status will change to revoked and will be displayed in green.

Activate Application

  • Click the Activate button.

  • Confirm the action to activate the application.

  •  Once activated, the application status will change to activated and will be displayed in green.

Delete  Application

  • Click the Delete button.

  • Confirm the action to delete the application.

  •  Once deleted, the application will no longer be visible on the screen.

View Application Details

Click the View Details button to:

  • Access and edit the application's details
  • Enable/Disable Capabilities
  • Manage API keys 
  • Manage access tokens.

Clicking the View Details button will take you to the application details page.

  1. Edit Application Details
  • Click on the three dots, then select Edit to edit the application. 

  • Edit the following details based on your requirements:
    • Application Name and Application Description
    • Enable/Disable Capabilities
  • Finally, click Save to apply the changes.

  1. API Key Management

Add API Key
  • Click Add Key
  • A new Client ID and Client Secret are generated

Note: A maximum of 3 API keys can be added per application.

Revoke API Key

Click on the three dots under Actions, and select Revoke Key to immediately disable an API key.

When revoked:

  • API key becomes inactive
  • All access tokens generated using this key stop working
  • New tokens cannot be generated

Activate API Key

Click on the three dots under Actions and select Activate Key to re-enable a previously revoked API key.

When activated:

  • API key becomes active
  • New access tokens can be generated
  • Previously issued tokens remain invalid

Delete API Key

Click on the three dots under Actions and select to permanently remove an API key.

When deleted:

  • The API key is permanently removed
  • All associated access tokens are invalidated
  • The key cannot be recovered

Access Token Management

Create Access Token
  • Click on the three dots under Actions and select  + Create Access Token

  • Select access token validity (minutes/hours/days), enter a value, and click Save.

Note: Minimum expiry is 3 minutes, and maximum is 30 days.



 

  • Once saved, an access token is generated in the dialog box. Copy or download and close the dialog box using the (x) icon.

Important: Access tokens can be viewed, copied, or downloaded only once. Therefore, ensure you download or securely save the token for future reference, as it cannot be retrieved again.



 

Refresh Access Token
  • Click on the three dots under Actions and select Refresh Access Token.



 

  • Select access token validity (minutes/hours/days), enter a value, and click Save.

            Note: Minimum expiry is 3 minutes, and maximum is 30 days.

  • Once saved, a new access token is generated in the dialog box. Copy or download and close the dialog box using the (x) icon.

Important: Access tokens can be viewed, copied, or downloaded only once. Therefore, ensure you download or securely save the token for future reference, as it cannot be retrieved again.

Access Token Information

Users can view the following Access Token details:

  • Access Token Expires At - The exact date and time when the token will expire.

     
  • Access Token Expires In -  It indicates how many days the access token is valid from the time it is generated.
  • It represents a fixed (static) validity period.
  • The value does not dynamically decrease in the dashboard.
  • It simply shows the total token lifespan (for example, 30 days).

To determine the exact expiration date and time, refer to Access Token Expires At, which displays the precise expiry timestamp.

Client ID and Client Secret Information

Client ID
  • Click the Copy button next to the Client ID.
  • The Client ID will be copied directly to your clipboard.

Client Secret
  • The Client Secret is masked by default for security purposes.
  • Click the Client Secret (eye/reveal) button to display the secret.

  • Once revealed, the Client Secret can be:
  • Viewed
  • Copied
  • Downloaded

Important: The Client Secret can only be copied, viewed, and downloaded once after it is revealed. For security reasons, the system does not permanently store a viewable version of the secret.

  • If you forget your Client Secret or fail to save it during the initial reveal:
  • You cannot view the same Client Secret again.
  • The system will not re-display the existing secret.
  • You must generate a new Client Secret.

Regenerate Client Secret
  • Click Add Key

  • A new Client ID and Client Secret are generated

  • Save the new secret immediately in a secure location.

  • Require updating the secret in all integrations and applications currently using it.

Note: A maximum of 3 API keys can be added per application.
 

 

 

Related to:

Jumper Conversational Connect Jumper.ai

Articles in this section