cURL

API Reference

The Evntaly Web SDK allows developers to seamlessly track user events, identify users, and manage analytics through simple HTTP API calls.

Track Event API

Endpoint: POST https://evntaly.com/prod/api/v1/register/event

Description: Sends a custom event to Evntaly for tracking.

  curl -X POST https://evntaly.com/prod/api/v1/register/event \
  -H 'Content-Type: application/json' \
  -H 'secret: YOUR_DEVELOPER_SECRET' \
  -H 'pat: YOUR_API_TOKEN' \
  -d '{
      "title": "Account License Upgraded",
      "description": "User upgraded their license to Pro",
      "message": "take care.",
      "data": {
          "user_id": "67890",
          "timestamp": "2025-01-08T09:30:00Z",
          "referrer": "social_media",
          "email_verified": false
      },
      "tags": [],
      "notify": true,
      "icon": "⤴️",
      "apply_rule_only": false,
      "user": {
          "id": "0f6934fd-99c0-41ca-84f4"
      },
      "type": "Page View",
      "sessionID": "20750ebc-dabf-4fd4-9498-443bf30d6095_bsd",
      "feature": "Backend API",
      "topic": "@api"
  }'

Example Response

{
    "status": "success",
    "message": "Event tracked successfully."
}

Identify User API

Endpoint: POST https://evntaly.com/prod/api/v1/identify/user

Description: Associates user information with analytics events.

curl -X POST https://evntaly.com/prod/api/v1/identify/user \
-H 'Content-Type: application/json' \
-H 'X-Project-Token: YOUR_API_TOKEN' \
-d '{
    "id": "0f6934fd-99c0-41ca-3333",
    "email": "Mayan@me.com",
    "full_name": "Mayan Alameer Ashraf",
    "organization": "Home",
    "data": {
        "id": "Mayan",
        "email": "Mayan@Decaud.com",
        "Location": "Egypt",
        "salary": 1233312,
        "timezone": "Africa/Cairo"
    }
}'

Example Response

{
    "status": "success",
    "message": "User identified successfully."
}

Tips for Using cURL

  • Use Verbose Mode: Add -v to see detailed request and response headers.

  • Debug JSON Payloads: Test JSON with tools like jsonlint.com to avoid syntax errors.

Support

For additional help, contact support at support@evntaly.com.

Last updated