Skip to main content

How can we help?

Search

Third-Party Integration Setup

Edited:

Follow these steps to grant a third-party integrator access to your Organisation in Consignly. 

 

Create a Role for the Integrator

  Role configuration is critical. Integrators should only receive the minimum permissions required for their integration. Do not reuse existing staff roles - create a dedicated role so access can be audited and revoked independently.

 

Choose your role strategy based on your integration setup:

Scenario Recommended Approach
One integrator manages the whole organisation

Create a single organisation-wide Integrator role.

Everyone assigned to this role can access data across the entire organisation.
Each integrator should only see their own partner's data Create a partner-specific role for each integrator, such as Integrator - Partner Name, and enable Partner Restricted on the role.

 

In Consignly, navigate to Settings > Roles.

Create a new role using the appropriate strategy. 

Under permissions, enable Integrations > Apps and restrict all other permissions to only what the partner strictly requires. 

If this role is for a partner-scoped integrator: enable the Partner Restricted option on the role. This confines the integrator's access to the partner they are associated with and prevents cross-partner data exposure. 

Finally, save the role. 

  Partner Restricted is strongly recommended for any external integrator representing a single partner. Without is, an integrator user has visibility across all partners in your organisation.

 

Invite the Integrator

Navigate to Settings > Users.

Invite the integrator using their email address. 

Assign them to their created role. 

 

Share Instructions with the Integrator

Once the integrator has accepted the invitation, ask them to follow the Consignly Knowledge Base instructions to create a custom app and generate their API credentials.