How to Create an API User & Generate API Keys in Momentum AMS

Creating an API User and Generating API Keys in Momentum AMS

Momentum AMS allows agencies to configure API access for integrations with external systems and third-party applications.

Setting up API access involves two steps: creating a dedicated API user and generating an API key associated with that user. This guide walks through both processes, including how to manage API credentials securely.

ⓘ Before You Begin

API setup requires access to your agency's configuration and agent management areas in Momentum AMS.

  1. Create an API User: Add a dedicated agent record with the API Integration role.
  2. Generate an API Key: Create an API key and associate it with the API user.

Part 1: Create a Dedicated API User

The first step is to create a dedicated agent record for API integration purposes.

Step 1: Open the Agents Page

  1. Log in to Momentum AMS.
  2. Click your agency or agent name in the upper-right corner.
  3. Select Agents from the dropdown menu.

Accessing Agents from the agency dropdown in Momentum AMS

Step 2: Add a New Agent

On the Agents page, click + Add New next to the Agents heading.

Add New button on the Agents page

Step 3: Enter the API User Information

Complete the new agent form using the following recommended configuration:

FieldRecommended Value
Agent TypePerson
First NameYour Agency Name
Last NameAPI
Email AddressDedicated API email address, such as API@youragency.com
Primary RoleAPI Integration

Creating an API Integration agent record

✓ Best Practice: Use a Dedicated API Account

Create a separate API user rather than using an individual employee's account. This makes it easier to identify the account used for integrations and manage its credentials independently.

Step 4: Configure Account and Permissions

Scroll to the Account and Permissions section and configure the following settings:

  • Active: Checked.
  • User: Leave unchecked. The API user does not need to log in directly.
  • Admin: Checked, as specified in this API integration setup procedure.
  • Time Zone: Select your agency's time zone.
⚠ Important: Administrative Permissions

This setup procedure specifies enabling the Admin permission, which grants broad system access. Ensure that API credentials are shared only with authorized integration administrators and trusted integration partners.

Step 5: Save the API User

After entering the required information and configuring the account permissions, click Save Changes.

Step 6: Set the API User Password

  1. Open the newly created API agent record for editing.
  2. Click Change Password.
  3. Enter a secure password.
  4. Save the new credentials.

Changing the password for the API user

ⓘ API User Created

Once the API user has been saved and its password configured, proceed to Part 2 to generate an API key associated with that account.


Part 2: Generate API Keys

Momentum AMS provides two methods for accessing API key configuration.

The recommended method is through the Agency Profile, although the original Configure API option is also available from the Agents page.

Method A: Generate API Credentials from the Agents Page

  1. Navigate to the Agents list.
  2. Click Configure API in the upper-right corner.
  3. Review the API credentials displayed.

This is the original method for accessing API credentials.


Method B: Generate API Keys from Agency Profile (Recommended)

Step 1: Open Agency Profile

  1. Click your agency name in the upper-right corner.
  2. Select Agency Profile from the dropdown menu.

Opening Agency Profile in Momentum AMS

Step 2: Navigate to API Keys

  1. On the Agency Profile page, locate the tab navigation area.
  2. Click the dropdown arrow on the right side of the tab bar.
  3. Select API Keys.
  4. Click Generate API Keys.

Selecting API Keys from the Agency Profile navigation

Generate API Keys option in Momentum AMS

Step 3: Generate the API Key

The Generate API Keys window will appear.

  1. In the Agent field, select the dedicated API user created in Part 1.
  2. Set an Expiration Date for the API key.
  3. Click Generate.

Generate API Key window with Agent and Expiration Date fields

Step 4: Copy and Securely Store Your API Key

After generating the API key, the new entry will appear in the API Keys table.

⚠ Important: Secure Your API Key

Copy and securely store your API key when it is generated. The key value will be masked in the API Keys table for security.

Treat API keys like passwords. Do not share them through unsecured communication channels or include them in publicly accessible documentation.


Part 3: Managing API Keys and Credentials

API Key Expiration

API keys have an expiration date that is selected when the key is generated.

Make note of this date and plan to generate a replacement key before the existing key expires.

⚠ Important: Plan for Key Expiration

An expired API key may interrupt an integration that relies on it. Track expiration dates and coordinate replacement credentials with your integration provider before the existing key expires.

Manage Existing API Keys

Existing keys can be managed from the API Keys table within Agency Profile.

Use the Actions dropdown next to an API key to access its available management options.

API User Subscription Requirements

ⓘ Subscription Seat Requirement

The dedicated API user counts as a seat on your Momentum AMS subscription. Keep this in mind when configuring API access for your agency.


API Setup Checklist

Use this checklist to confirm your API access has been configured.

  • ☐ Dedicated API agent created.
  • ☐ Agent Type set to Person.
  • ☐ Primary Role set to API Integration.
  • ☐ Active and Admin permissions configured.
  • ☐ User option left unchecked.
  • ☐ Agency time zone selected.
  • ☐ API user password created.
  • ☐ API Keys section opened from Agency Profile.
  • ☐ Correct API agent selected.
  • ☐ API key expiration date established.
  • ☐ API key generated and securely stored.

Need Additional Assistance?

If you need assistance creating an API user, generating API keys, or reviewing API configuration, contact Momentum Support.

API Access Configuration Complete

Once your dedicated API user has been created and an API key has been generated, you can provide the required credentials to your authorized integration provider.

Keep your credentials secure and monitor API key expiration dates to help maintain uninterrupted integration access.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article