Establishing a Secure Custom Integration

Private integrations offer a secure and powerful way to manage your account's third-party connections. By utilizing tokens instead of API keys, this feature provides enhanced control and security.

Core Advantages

• Stronger Protection: Users can define what third-party apps can access in their accounts, offering stronger security compared to traditional API keys.

• More Functionality: With API v2.0 support, users gain access to expanded features, including Webhooks, broadening the integration's potential.

• Streamlined Management: This feature allows users to implement best practices for token management, including options like ‘Rotate’ or ‘Expire Later.’

Why You Need Private Integrations

The transition from API v1 to API v2 through Private Integrations enhances security and functionality, offering a more secure and efficient way to manage custom integrations.

Steps to Create a Private Integration

1. Go to your account's Settings tab.

2. Select Private Integrations from the sidebar.

3. Click on the ‘Create New Integration’ option to begin.

Configuring Your Integration

• Integration Name: Provide a clear, descriptive name for your integration.

• Description: Write a brief description to explain the integration’s purpose.

• Permissions: Specify the access and permissions that the third-party application will have, limiting them to only what’s necessary for security purposes.

Generating an Access Token

After configuring the settings, click ‘Generate Access Token.’ Copy the token immediately as it won’t be shown again. Use this token to connect the third-party app to your account.

Testing Your Integration

Use the generated token to connect the third-party app and test the integration to ensure it operates as expected with the assigned permissions.

Managing Your Integrations

You can manage tokens by visiting the Integration tab. Rotate or expire tokens as needed using the available features like 'Rotate Now' or 'Expire Now.'

Common Questions

• Q: How does this enhance security over API keys?
  By limiting scopes, it ensures developers have restricted access, reducing the risk of unauthorized usage.

• Q: What benefits does API v2.0 offer?
  API v2.0 adds more functionality and Webhooks, making it more versatile compared to API v1.

• Q: How do I effectively manage tokens?
  Use 'Rotate' or 'Expire' options to manage tokens and maintain security best practices.

Troubleshooting Advice

• Double-check permissions: Make sure the correct scopes are selected to avoid unauthorized access.

• Regular token updates: Rotate your tokens regularly using the ‘Rotate Now’ feature for added protection.

• Monitor token usage: Keep track of token activity and utilize the auto-expire feature to prevent inactive tokens from being misused.