Skip to main content

Account Setup Guide

This guided flow helps you configure your account through API Key creation, search, configure and active your connector, and start building with our unified APIs.

  1. API Authentication – Generate secure access credentials
  2. Service Integration – Connect your development tools
  3. Webhook Configuration – Enable real-time notifications
  4. Team Collaboration – Add team members (optional)

Prerequisites​

Before starting, ensure you have:

  • An active Unizo Console account
  • Access to the third-party services you want to integrate

Step 1: API Authentication​

Your API key provides secure access to all Unizo APIs. Keep it confidential and never expose it in client-side code.

Quick Setup​

  1. Access the API Key section

    • From your console, click API keys
    • Or use the guided setup flow from the welcome screen

  2. Generate your key

    • Click Generate API key
    • Click the visibility icon to reveal your key
    • Copy the key immediately - it won't be shown again

  3. Secure storage

    • Store your API key in a secure location (password manager, environment variables)
    • Never commit API keys to version control
API Key Example

Generate API key

Authentication Testing​

Verify your API key works correctly:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.unizo.ai/v1/health

Expected response: {"status": "200", "version": "1.0"}

Step 2: Configure Service Integrations​

Connect Unizo to your development ecosystem by enabling the services you use.

Integration Setup​

  1. Select Setup Integrations

    • Choose from the available categories based on your needs
    • Each category displays available connectors

  2. Enable specific connector

    • Toggle the connectors you want to connect

  3. Configure authentication

    • Setup the PAT or OAuth flow auth methods to support your customers
Description

Setup Integrations

Integration Best Practices​

  • Start small - Enable 2-3 core connectors initially
  • Review permissions - Grant only necessary access scopes
  • Monitor usage - Check integration health regularly
  • Document settings - Keep a record of your configuration choices

Step 3: Set Up Webhooks​

Webhooks enable real-time notifications when events occur in your integrated services.

Webhook Configuration​

  1. Create webhook endpoint
    • Navigate to Setup Integrations → Webhooks
    • Click Create Callback URL
Description

Setup Webhooks

  1. Configure webhook settings
    • Select Category: Select the service category (e.g., source-code, ticketing)
    • Callback URL: Your application's webhook endpoint (must be HTTPS)
    • Content Type: Set to application/json (recommended)
    • Secret: Generate a strong, unique string for signature verification
    • API Key: Use your generated API key for authentication
Description

Set up webhook endpoints to receive real-time notifications

Development Testing​

For local development, use ngrok to create a secure tunnel:

# Install ngrok
npm install -g ngrok

# Start your local server (e.g., port 3000)
node server.js

# Create secure tunnel
ngrok http 3000

Use the generated HTTPS URL as your webhook callback URL.

Step 4: Invite Team Members (Optional)​

Collaborate effectively by adding team members to your Unizo workspace.

Roles​

Unizo provides the following user roles:

  • OrgAdmin: The standard role for Leads. Users with this role have full permissions to manage any activity within the Unizo Console.
  • Observer: The standard role for users who oversee observability activities in your organization.
  • DevOps: The standard role for Developers. Ideal for small teams or developer-first environments.

Permissions​

The table below details the permissions available for each role:

FeatureOrgAdminObserverDevOps
Home✅✅✅
Integrations✅✅✅
Logs✅✅✅
Setup Integrations✅❌✅
Security✅❌✅
Connect UI✅❌✅
API keys✅❌✅
Account Settings✅❌❌

Team Invitation Process​

  1. Access user management

    • Navigate to Account Settings → Users
    • Or use the Invite Users guided setup flow from the welcome screen

  2. Invite New Users

    • Enter team member email address
    • Select appropriate role
    • Click Send Invite

  3. Track invitation status

    • Monitor pending invitations from View Pending Users
    • Resend invitations if needed
    • Revoke access for departed team members
Description

Invite Team

Verification and Next Steps​

Setup Verification Checklist​

Confirm your setup is complete:

  • API key generated and stored securely
  • At least one service integration configured and tested
  • Webhook endpoint configured and receiving events
  • Team members invited (if applicable)
  • Test API calls return expected results

Testing Your Setup​

Run this comprehensive test to verify everything works:

# Test API connectivity
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.unizo.ai/api/v1/integrations

# Expected: List of your configured integrations

Congratulations! Your Unizo Console is now configured and ready for production use.

For additional support, contact our team at support@unizo.ai.