API & Integrations - The Integrations Hub for Cloud Gateway

This article contains information on using the Mimecast Integrations Hub for Email Security Cloud Gateway, to manage, create, and amend integrations, and gives information on troubleshooting common issues.

Overview

The Integrations Hub is a centralized location, where you can access all integrations supported by Mimecast.
Depending on the products purchased from Mimecast, you will be able to configure some or all integrations. 
For integrations that you do not have a package for, you will see a Learn More link.

The Integrations Hub can be used by all Mimecast customers developing API and service integrations within Mimecast, as well as those utilizing Mimecast to connect with third-party services through service and API integrations.

You can use the Integrations Hub to:

• Find and monitor the status of integration(s) across your organization.
• Evaluate potential integration opportunities.
• Automate workflows within your organization, by synchronizing information between platforms.

Prerequisites

To use the Integrations Hub, you must have either:

• Super Administrator, Full Administrator, or Partner Administrator permissions.
• Read/Write permissions enabled for the Integrations Marketplace, for the Role associated with your user credentials. 

Managing Integrations

Creating an Integration

You can create an Integration, by using the following steps:

1. Log in to the Mimecast Administration Console.

2. Navigate to Integrations | Integrations Hub.

   
   
    

   Some legacy integrations can be found under Services | Connectors and Services | API and Platform Integrations and will be available for configuration there.

3. A list of all available integrations is displayed.
4. Click on Configure New next to the integration you wish to configure.
5. Accept the Terms and Conditions, when prompted to do so.
6. Enter the details for the Integration on the Create Integrations screen, including:

•  
  • Integration name.
  • Description.
  • Contact details.
  • Any further configuration specific to the integration.

7. Click on Save.

View / Edit an Integration

You can view / edit an Integration, by using the following steps:

1. Log in to the Mimecast Administration Console.

2. Navigate to Integrations | Integrations Hub.

   Some legacy integrations can be found under Services | Connectors and Services | API and Platform Integrations and will be available for configuration there.

3. A list of all available integrations is displayed.
4. Click on View next to the integration tile you wish to view or edit integrations for.
5. A list of all available integrations is displayed, for the selected integration type.

6. Click on the ellipsis "..." next to the required integration, and select View/Edit Integrations next to the integration you wish to modify.

   
7. In Edit Integrations, make any changes required.
8. Click on Save Changes.
9. A pop-up "toast" notification will appear, to confirm that the changes have been made.

Deleting an Integration

You can delete an Integration, by using the following steps:

1. Log in to the Mimecast Administration Console.

2. Navigate to Integrations | Integrations Hub.

   Some legacy integrations can be found under Services | Connectors and Services | API and Platform Integrations and will be available for configuration there.

3. A list of all available integrations is displayed.
4. Click on the integration tile for the integration type to be modified.
5. A list of all available integrations is displayed, for the selected integration type.

6. Click on the ellipsis "..." next to the required integration, and select Delete next to the integration you wish to modify.

   
7. Confirm when prompted to delete the integration.

Frequently Asked Questions

The table below displays answers to Frequently Asked Questions, and Troubleshooting tips, for the Integrations Hub.

Q:	Will I be required to migrate integrations?
A:	No, however, any new integrations created should be established in the Integrations Hub.
Q:	Will I be required to take any actions?
A:	You must accept the new API terms and conditions. Additionally, you should browse the repository for any new integrations that are being made available for configuration based on your product selection within Mimecast. This reduces legal risk, and ensures consistent compliance across all users of integrations.
Q:	Will all integrations be available at launch?
A:	Some legacy integrations will continue to be displayed under Services | Connectors and Services | API and Integrations pages. We are actively working on projects to migrate them from their old locations to the new Integrations Hub menu item.
Q:	What permissions are required for a user to create or manage integrations?
A:	To create integrations, you should have Super Administrator, Full Administrator, or Partner Administrator permissions assigned. Alternatively, the role associated with your user credentials should have the Integrations Marketplace Read/Write permission enabled.
Q:	What are some common errors and their resolutions?
A:	Authentication & Authorization Issues Status: STATUS_UNHEALTHY Error: "Invalid API Key" or "Authentication Failed" Cause: Incorrect API key, expired token, or insufficient permissions. Fix: Double-check API keys and credentials. Reauthorize the integration in the Integrations Hub. Ensure the user has the necessary permissions. Data Sync Failures Status: STATUS_UNHEALTHY Error: "Data Sync Failed" or "Partial Data Transfer" Cause: API rate limits, mismatched field mappings, or network issues. Fix: Review integration logs for errors. Verify field mappings and data formats. Retry syncing after a brief interval if the API is rate-limited. Missing or Incorrect Data Status: STATUS_UNHEALTHY Error: "Required Field Missing" or "Invalid Data Format" Cause: Incomplete form submissions or incorrect formatting (e.g., date/time, currency). Fix: Ensure all required fields are completed prior to submission. Validate data formats before transmission. Integration Not Displayed in Connected Apps Status: STATUS_UNHEALTHY Error: "App Not Found" or "Integration Not Available" Cause: Incorrect setup, outdated software versions, or application restrictions. Fix: Confirm if the application supports the integration. Update both platforms to the latest versions. Verify if admin approval is necessary. API Connection Issues Status: STATUS_UNHEALTHY Error: "API Call Timeout" Cause: Server downtime or firewall restrictions. Fix: Review firewall settings and allowlisted IP addresses. Performance & Latency Problems Status: STATUS_UNHEALTHY Error: "Slow Response Time" or "Integration Timing Out" Cause: High data load, slow API responses, or delays in background processing. Fix: Optimize data processing (consider batch synchronization instead of real-time). Monitor API rate limits and enhance API call efficiency.
Q:	How can I contact support if needed?
A:	For any further inquiries, please refer to the Customer Community.
Q:	Are there any additional costs or subscription requirements?
A:	The Integrations Hub serves as a centralized location for you to view all integrations supported by Mimecast. Depending on the product purchased from Mimecast, you may have the ability to configure some or all integrations. For integrations that the customer does not have a package for, they will see a Learn More link.
Q:	Will these integrations be impacted by the API 1.0 End Of Life (EOL) plan?
A:	The integrations available under the Integrations Hub utilize API 2.0. Therefore, we highly recommend all our users to keep an eye out for integrations that have now been moved to the new Integrations Hub menu and configure them as necessary.

See Also...

• API & Integrations - Managing API Applications
• API & Integrations - The Integrations Hub for Cloud Integrated
• Mimecast Developer Hub