Skip to main content
POST
/
api
/
v2
/
signals
curl --request POST \
  --url https://zeroclick.dev/api/v2/signals \
  --header 'Content-Type: application/json' \
  --header 'x-zc-api-key: <api-key>' \
  --data '
{
  "userId": "user-12345",
  "ipAddress": "your-user-ip-address",
  "signals": [
    {
      "category": "purchase_intent",
      "confidence": 0.9,
      "subject": "Nike running shoes",
      "sentiment": "positive"
    }
  ]
}
'
{
  "error": {
    "message": "Invalid request body: signals must contain at least 1 element(s)"
  }
}

Authorizations

​
x-zc-api-key
string
header
required

Tenant API key for authentication. Obtain from https://developer.zeroclick.ai/ under API Keys. This key should be kept secure and not exposed in client-side code when using server-side integration.

Body

application/json
​
signals
object[]
required

Array of real-time signals about the user's current context or intent. These signals are stored for future offer matching and personalization.

Required array length: 1 - 10 elements
​
ipAddress
string

Client IP address. Forward the end user IP address for user matching and personalization.

​
userAgent
string

Client User-Agent string.

​
userId
string

Tenant-defined user ID for analytics and personalization

​
userSessionId
string

Tenant-defined session ID for session-level tracking

​
userLocale
string

User locale/language code (e.g., "en-US", "es-MX")

​
userEmailSha256
string

SHA-256 hash of user email address for identity matching (lowercase, trimmed before hashing)

​
userPhoneNumberSha256
string

SHA-256 hash of user phone number for identity matching (E.164 format before hashing)

​
groupingId
string

Tenant-defined grouping ID for analytics segmentation

Response

Signals stored successfully (no content returned)