One-time Setup Flow

Generate API Key

• Request a secure API key from Zluri Support.
• This key will be used in the header of all future requests.

Check Authentication for more details.

Create Integration Instance

An Instance in Zluri represents a connection between your custom application and the Zluri platform. Creating an instance is the first step to start syncing data from your app.

What You’ll Need

• appId: The unique identifier of the application you're integrating
• Instance Name: A unique name for the integration
• (Optional) Notification Emails: Email addresses to receive sync status updates

How to Find the appId

1. Go to the Zluri Dashboard.
2. Navigate to Applications and select your app.
3. Check the URL — it will look like this:

https://<your-org>.zluri.com/applications/67adde3b1fa54355431b4d4r#overview

The part after /applications/- 67adde3b1fa54355431b4d4r is your appId.

Note: If the app doesn’t exist in Zluri yet, go to Applications → + Add to create it and use its appId.

Important Note

Notification email: Providing notification emails ensures that your team receives timely updates about the sync status—such as failures or warnings —helping you monitor and troubleshoot issues proactively.