Create a custom integration to easily create custom object records and take advantage of the following benefits:
- Flexibility: Custom integrations broaden the range of systems you can connect with.
- Data Integrity & Efficiency: Importing custom object records via an API reduces manual input, cuts down on errors, and saves time.
- Scalability: Use custom objects to adapt your Oomnitza environment to your specific requirements.
In the following article, we'll detail the process of creating a security certificate object and importing its records.
Before you start
The following example uses the SSLMate: Search API to conduct SSL certificate searches.
➢ Read the external API documentation
It is important to plan the integration so that you choose the right options and have the information that you need to add the integration. Refer to your application documentation for information about the Webservice URL, HTTP method, headers, and the parameters that are required for the API call.
➢ Limitations
The following features are not available:
- SaaS users can’t be selected when you create a custom user integration.
- The option to create your own OAuth, Session Based, or Signed Request authentication is not available. If you decide to use OAuth, session based, or signed request, you must choose from a preconfigured list of credentials.
- Other HTTP Methods such as PUT or PATCH are not available. Only GET or POST HTTP methods are supported.
- Integrations do not support self-signed certificates. Attempting to use a URL with a self-signed certificate will likely result in an [SSL: CERTIFICATE_VERIFY_FAILED] error. To ensure the security of data exchanges between Oomnitza and external servers, integrations can only establish connections with servers that possess trusted certificates issued by recognized Certificate Authorities (CAs). We recommend that you either switch to a CA-issued certificate (recommended) or add the server's self-signed certificate to the trust store (least recommended).
Create the custom object and add it to the menu
If you are syncing data to a custom new object, ensure that the object already exists in Oomnitza and is added to the main menu for your convenience.
Create the custom integration
- Click Configuration > Integrations.
- Click + Add in the upper right of the page.
- Select the custom object from the list.
- Add the integration details.
- If you selected Cloud as the Installation Type, enter the credentials.
- Schedule the integration.
For detailed instructions, see Creating a custom extended integration
Retrieve the response
If you selected Cloud as the Installation Type, click Test Run in the sidebar.
If you selected local as the installation type, you must add your credentials to the config.ini file which is generated in your local environment.
For further details, see Custom local extended integration: Retrieve an API response
Map the custom integration
To map a custom extended integration, complete the following steps:
If the fields you want to map, were created in Oomnitza
- Click Smart Mapping to automatically map the fields.
- Values from the integration can also be drag and dropped onto the matching Oomnitza field, or selected from the integration field dropdown.
If the fields you want to map are not yet created in Oomnitza:
- Create custom mappings to map the field that you want to add to Oomnitza. To create a custom mapping, complete the following steps:
- Click the down arrow on the field that you want to map.
- Select Add new Oomnitza field.
- Change the name of the field.
- Select the Unique checkbox if you want to use this custom field as the sync key.
- Click CREATE.
- Select a sync key. This field must have unique values.
- Click UPDATE.
Did you know?
You can click Edit integration to define rules for your integration. For example, you might want to run the integration only if certain conditions are met.
Run the custom integration
- Click Run Now.
- Click Sync Sessions and review the status of the integration.
Getting your results
To view the information that is retrieved from the integration, navigate to the custom object you added to the menu.
Next steps
- Create a workflow for the Security Certificate custom object.
- In the Begin block, target the certificates that are due to expire. For example, Expiry Date Next Month
- Add a Notification block to the workflow to alert the individuals tasked with renewing the certificate.
Comments
0 comments
Please sign in to leave a comment.