Overview

​

What You Can Do

• Manage Users - Create, update, and delete project users; store and update custom user properties for segmentation and personalization
• Send Messages - Deliver push notifications directly to user devices with custom content
• Trigger Campaigns - Trigger pre-configured campaigns to specific users or broadcast to your entire user base

​

Base URL

https://api.clix.so

​

Authentication

​

API Key Types and Use Cases

​

Key Selection Guide

• Public Key: Use for direct SDK integrations where your application frontend communicates with Clix
• Secret Key: Use for sensitive operations including user management, message sending, and campaign triggering

​

Example Request

curl -X POST https://api.clix.so/api/v1/users \
  -H "X-Clix-Project-ID: your_project_id" \
  -H "X-Clix-API-Key: your_secret_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "user": {
      "project_user_id": "user_123"
    }
  }'

​

Protecting Your API Keys

• Store keys in environment variables or dedicated secrets management platforms
• Implement key rotation policies in your organization
• Apply the principle of least privilege—use Public keys in client applications, Secret keys only in trusted backends
• Regularly audit API key usage and revoke unused keys
• Enable alerts if unusual API activity is detected

​

Rate Limits

​

Content Type

Content-Type: application/json

​

Response Codes and Error Handling

​

Success Codes

​

Client Error Codes

​

Server Error Codes

​

Error Response Format

{
  "error": "Invalid project user ID format"
}

​

Implementing Reliable Retries

async function makeRequestWithRetry(url, options, maxAttempts = 3) {
  for (let attempt = 0; attempt < maxAttempts; attempt++) {
    try {
      const response = await fetch(url, options);

      // Don't retry client errors (4xx) - they won't succeed with retry
      if (response.status < 500) {
        return response;
      }

      // On last attempt, throw the error
      if (attempt === maxAttempts - 1) {
        throw new Error(`Server error: ${response.status}`);
      }

      // Calculate exponential backoff: 1s, 2s, 4s, etc.
      const delayMs = Math.pow(2, attempt) * 1000;
      await new Promise(resolve => setTimeout(resolve, delayMs));
    } catch (error) {
      if (attempt === maxAttempts - 1) throw error;
    }
  }
}

​

OpenAPI Specification

​

API Endpoints

​

Users

• Create User - Register a new project user
• Update User - Modify user properties and attributes
• Delete User - Permanently remove a user from your project

​

Campaigns

• Trigger Campaign - Execute a campaign, targeting specific users or broadcast to all users matching campaign filters

​

Messages

• Send Messages - Deliver push notifications directly to specified devices

​

SDK Integration

• iOS SDK
• Android SDK
• React Native SDK
• Flutter SDK

​

Request Timeout

​

Integration Guidelines

• Always use HTTPS - Connections must be encrypted with TLS 1.2 or higher
• Implement exponential backoff - Automatically retry on 5xx errors with increasing delays (1s, 2s, 4s…)
• Respect rate limits - Monitor response status and throttle requests to stay within limits
• Log responses - Track API responses for debugging and monitoring
• Validate inputs - Check that project user IDs and other identifiers match expected formats
• Choose keys wisely - Use Public keys for SDKs, Secret keys only for backend services

​

Support

• Email: [email protected]
• Documentation: https://docs.clix.so