MAS - Creating and configuring API keys for push notifications

Push notifications in IBM Maximo Application Suite (MAS) Manage allow field technicians and users to receive real-time alerts on their mobile devices — without having to manually refresh or stay logged in. Before any notification can be delivered, you need to generate an API Key from IBM's Push Notification service and then configure it inside MAS Administration. This article walks you through every step with full explanation of what each setting does and why it matters.

💡 Who needs this? MAS Administrators setting up mobile push notifications for Maximo Manage users on iOS or Android devices. This is a one-time setup per MAS environment (DEV / TEST / PROD each need their own API Key).

🔔 What Are Push Notifications in MAS Manage?

MAS Manage supports sending push notifications directly to users' mobile devices via the IBM MAS Mobile app. These can include workflow approvals, assignment alerts, work order updates, and service request status changes. The mechanism relies on IBM's hosted Push Notification service, which acts as the delivery bridge between MAS and the device.

The integration requires two things to be in place:

1. An API Key generated from the IBM Push Notification portal, which authorises MAS to send messages via the service.
2. The API Key and endpoint URL configured inside MAS Administration so the platform knows where and how to route notification requests.

⚠️ Upgrading from a Previous Version?
If you are upgrading from an older version of Maximo Manage, you may have a saved (bookmarked) URL that is no longer valid. Always double-check any previously saved portal URLs before following the steps below — IBM may have updated the endpoint.

🔑 Part 1 — Generating the API Key

The first part of the process is performed outside of MAS, directly on IBM's Push Notification portal. You will need a valid IBM ID to authenticate.

Step 1 — Open the Push Notification Portal

Open a browser and navigate to the IBM Push Notification authentication page:

https://pushnotification.suite.maximo.com/pushnotification/auth

📌 Tip: Use a browser that is not behind a strict corporate proxy for this step. Some enterprise proxies block external IBM portal traffic. If the page doesn't load, try from an alternate network or raise it with your network team.

Step 2 — Sign In with IBM ID

On the portal page, click "Sign in or up". You will be redirected to IBM's identity provider (IBMid). Log in using your registered IBM ID credentials. If you don't have one, you can register for free at ibm.com.

Step 3 — Create and Generate the API Key

Once authenticated:

1. Enter a meaningful name for your API Key (e.g., MAS-PROD-PushNotif or MAS-TEST-PushNotif). Using environment-specific names makes key management easier if you're running multiple MAS instances.
2. Click "Generate API Key".
3. The portal will display the generated API Key value. Copy this immediately — the key will not be shown again once you leave the page.

⚠️ Important: Store the copied API Key securely (e.g., in a password manager or your organisation's secrets vault). If you lose it, you will need to generate a new one and reconfigure MAS.

⚙️ Part 2 — Configuring the API Key in MAS Administration

With the API Key copied, switch over to your MAS environment to complete the configuration.

Step 1 — Log in to Maximo Application Suite

Log in to your MAS environment with an account that has Suite Administration privileges.

Step 2 — Navigate to Push Notification Settings

1. Click the Administration icon (the gear/cog icon) from the MAS home screen.
2. Select Configurations from the left-hand navigation.
3. Under the "Users and identity" section, click "Push Notification".

Step 3 — Enter the Push Notification Configuration

Click "Edit" and populate the three fields as follows:

Field	Value to Enter	Notes
Bundle Identifier	com.ibm.iot.maximo.mobile	This is the iOS/Android app bundle ID for the IBM MAS Mobile app. Do not change this value.
URL	https://pushnotification.suite.maximo.com/pushnotification/sendMessage	IBM's hosted push notification delivery endpoint. This is the URL MAS will POST messages to.
API Key	Your generated API Key value	Paste the key you copied from the IBM Push Notification portal in Part 1.

Step 4 — Save the Configuration

Click "OK" to save the configuration. MAS will now use these credentials to dispatch push notifications to mobile users.

✅ Tip: After saving, ask a test user to log in via the MAS Mobile app and trigger a notification (e.g., a workflow assignment). Verify that the notification arrives on their device within a few seconds to confirm the integration is working end-to-end.

📋 Quick Reference Summary

Activity	Where	Who
Generate API Key	pushnotification.suite.maximo.com	IBM ID account holder
Configure Push Notification	MAS Admin → Configurations → Users & Identity	MAS Suite Administrator
Bundle Identifier	com.ibm.iot.maximo.mobile	Fixed value — do not change
Push URL	pushnotification.suite.maximo.com/pushnotification/sendMessage	IBM hosted endpoint

🔍 Things to Watch Out For

API Key Rotation: IBM does not enforce automatic expiry on these keys, but it is good security practice to rotate them periodically (e.g., annually) or immediately after a staff change where someone who held the key leaves the organisation. After rotation, you must update the API Key in MAS Administration.

Multiple Environments: If you run separate DEV, TEST, and PROD MAS environments, generate a separate API Key for each. This ensures notifications from a test environment don't inadvertently route through your production key.

Firewall / Outbound Connectivity: MAS needs outbound HTTPS access to pushnotification.suite.maximo.com on port 443. Ensure your MAS Manage pods / nodes are not blocked by network policies or firewall rules from reaching this endpoint.

Mobile App Version: Ensure your users have a version of the IBM MAS Mobile app that supports push notifications for your version of MAS Manage. Older app versions on older MAS releases may not fully support the push service.

📖 Official IBM Documentation: This article is based on the IBM Maximo Application Suite documentation for Maximo Manage (Continuous Delivery). For the latest updates, always refer to the official IBM Docs page:
IBM Docs – Creating and configuring API keys for push notifications