API & Integrations - The Integrations Hub for Cloud Integrated

This article contains information on using the Mimecast Integrations Hub for Email Security Cloud Integrated, 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 or Full Administrator permissions.

Managing Integrations

Creating an Integration

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

1. Log in to Email Security Cloud Integrated.
2. Navigate to Integrations | Integrations Hub.
   
   
   
   

   Some legacy integrations can be found under Integrations | Service Authorizations and Integrations | API 2.0 Applications 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 Email Security Cloud Integrated.
2. Navigate to Integrations | Integrations Hub.
   

   Some legacy integrations can be found under Integrations | Service Authorizations and Integrations | API 2.0 Applications 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 Email Security Cloud Integrated.
2. Navigate to Integrations | Integrations Hub.
   

   Some legacy integrations can be found under Integrations | Service Authorizations and Integrations | API 2.0 Applications 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:	Please refer to this Service Update, to the list of integrations that will be available to customers at launch. We will continue to post Service Updates and notify you as we add more integrations to the Integrations Hub. You are encouraged to look out for integrations that have now been moved to the new Integrations Hub menu and configure them as necessary. Depending on your current product within Mimecast, you will have the ability to configure integrations. A Learn more link will be displayed next to integrations that are not available based on your product selection.
Q:	Will all integrations be available at launch?
A:	Some legacy integrations will continue to be displayed under Integrations | Service Authorizations and Integrations | API 2.0 Applications.
Q:	What permissions are required for a user to create or manage integrations?
A:	Different users can have read and write permissions across the Integrations Hub. The breakdown of permissions by role is as follows: The Email Security Cloud Gateway Platform grants Read and Write permissions in the Integrations Hub Page to several user roles, including Super Administrator, Full Administrator, Basic Administrator, Partner Administrator, and a custom role with Integrations Marketplace that has Read/Write enabled. Additionally, a custom role with Integrations Marketplace that has Read enabled is assigned Read-only permissions. The Email Security Cloud Integrated Platform assigns specific permissions for users in the Integrations Hub Page. Users with Read and Write permissions include csp: super-admin, csp: full-admin, and csp: partner-admin. Meanwhile, users with Read-only permissions consist of csp: readonly-admin, csp: mimecastreadonly-admin, csp: basic-admin, csp: helpdesk-admin. Beyond this, each integration surfaced within the Integrations Hub may have its own conditions to allow you to create and manage the integrations. For example, have you purchased the product you are trying to create an integration for?
Q:	What are some common errors and their resolutions?
A:	Authentication and authorization issues can lead to errors such as "Invalid API Key" or "Authentication Failed." These problems may arise from an incorrect API key, an expired token, or insufficient permissions. To resolve these issues, users should double-check their API keys and credentials, reauthorize the integration in the Integrations Hub, and ensure that the user has the necessary permissions. Data Sync Failures refer to issues encountered during data synchronization processes, indicated by an error status such as "Data Sync Failed" or "Partial Data Transfer." Common causes include API rate limits, mismatched field mappings, or network problems. To resolve these issues, it is recommended to review integration logs for errors, verify field mappings and data formats, and retry syncing after a brief interval if the API is rate-limited. Missing or incorrect data in form submissions. It indicates that the status is marked as an error due to either a "Required Field Missing" or "Invalid Data Format." The causes of these errors include incomplete form submissions or incorrect formatting, such as date/time or currency. To resolve these issues, it is recommended to ensure that all required fields are filled out before submission and to validate data formats prior to transmission. Integration issue reported involves an error status indicating either "App Not Found" or "Integration Not Available." This can be caused by incorrect setup, outdated software versions, or application restrictions. To resolve the problem, users should confirm if the application supports the integration, update both platforms to their latest versions, and check if admin approval is required. API Connection Issues Status: Error Error: "API Call Timeout" Cause: Server downtime or firewall restrictions. Fix: Review firewall settings and allowlisted IP addresses. Performance & Latency Problems Status: Error 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 Gateway
• Mimecast Developer Hub