Zluri SDK FAQs

General FAQ

1. What are the advantages of migrating our current SDK integration to SDK V2?

Upgrading to SDK V2 provides enhanced integration management through the Operational APIs, offering flexibility for uploading, synchronizing, and managing your integrations as requirements evolve.

Key benefits:

No native connector required: Push data even if Zluri doesn’t natively support the application.
Full control over data selection, sync timing, and frequency.
Scalable uploads: Efficiently handle large datasets with paginated uploads.
Schema validation: Ensures high-quality data.
Real-time sync monitoring: Get detailed error feedback for faster issue resolution.

2. What is the sync time for the two data models within SDK V2?

Sync time varies depending on the data uploaded. By default, it can take up to 24 hours to process and display in the UI.

3. Is there an article available for implementing and hosting SDK integrations?

For implementation guides, refer to the official documentation. Zluri supports orchestration platforms like n8n, Workato, Jira, and Python scripts for hosting. Reach out to your Customer Success Manager (CSM) or Customer Success Engineer (CSE) for detailed hosting documentation.

4. Which method takes priority for displaying user names in Zluri?

The "Name" attribute is prioritized. If unavailable, the "First Name" and "Last Name" attributes will be used as fallback.

5. What is the difference between the Unique ID and User Name fields in User Entities?

Username: A unique identifier used in apps like GitHub. It is not a default field yet but may be available in future releases.
Unique ID: A mandatory field used to make changes to user attributes (excluding email). It ensures consistent identification across uploads.

6. Is it required to send a dynamic Unique ID for each user during every upload?

No, the Unique ID should remain static for each user across uploads to maintain consistent identification.

7. Can we change the email ID of a user using the Unique ID?

No, changing the email ID using the Unique ID will deactivate the old profile and create a new one with the new email ID.

8. Is it necessary to maintain the same Unique ID for users across different integrations?

No, the Unique ID can differ for the same user across different integrations. It is specific to the integration source.

9. Does the SDK integration notify the admin if there is a sync failure or data upload mismatch?

No, the SDK does not provide notifications for data upload issues. However, users listed in the Notification Email section during integration creation will be notified about sync failures or data issues.

10. Can we add non-existing users from Zluri to the Notification Email configuration?

No, only users present in the Zluri User Directory can be added. There is a limit of 3 users per integration.

11. Why can't I see data in Zluri immediately after completing the sync?

Zluri processes the data after syncing, similar to native integrations. The UI updates based on the uploaded data model.

12. Is there an API to view the list of integrations connected so far?

Yes, use the Get Integration Details API to view your connected integrations.

13. Can instance details like Created By, Status, or Notification Email be updated?

Yes, you can update instance details using the Update Instance API.

14. Can we use operational APIs for SDK V1 Integrations?

Yes, some operational API calls support V1 integrations. You can use the following:

Get Integrations List
Get Integration Syncs
Update Instance Details
Abort Synchronization

15. Can you let me know the required fields for each data entity?

You can check the required fields for each data schema in the Custom Integration SDK → Guides → Data Entities section. Detailed required fields are listed at the bottom of each schema page.

16. Does the SDK V2 Create Integration API prompt an error when mapping an application that is already mapped with other integrations?

No, the API currently does not prompt an error if the application is already mapped with other integrations.

17. Can we use the Transaction ID to update existing transactions sent via the SDK integration?

Yes, you can update transactions using the Transaction ID, provided the transactions were sourced via the same integration. Transactions from different integrations cannot be updated using the same ID.

18. Is it required to have a unique Transaction ID for each transaction uploaded via SDK V2?

Yes, each transaction must have a unique Transaction ID. You can use the same ID to reverse or update transaction attributes if needed.

19. Why are transactions uploaded and the sync complete, but not mapped to any application or visible under the Recognized section?

Transactions initially land under Unrecognized transactions. If an automation rule maps transactions based on Application or Vendor, they will be auto-mapped. Otherwise, a new rule needs to be implemented to enable mapping.

20. Are Zluri attributes case-sensitive?

Yes, Zluri attributes are case-sensitive and must be referenced exactly as documented.

21. If I mention the exchange rate for a transaction, will it automatically convert the value based on the currency code?

No, the exchange rate field only stores the exchange rate information. It does not perform automatic currency conversion.

22. Does the currency code attribute in Transaction entities support ISO code?

Yes, only ISO-formatted currency codes are supported in Zluri.

23. Is it necessary to upload contracts with a dynamic Contract ID every time?

Yes, each contract uploaded must have a unique Contract ID for proper identification.

24. Can we update existing contracts uploaded using SDK V2?

Yes, existing contracts can be updated as long as they were uploaded via the SDK integration and are identified using their unique Contract ID.