# Track a customer event

Source: https://jointextkit.com/docs/api/track/event
Index: https://jointextkit.com/llms.txt

`POST /v1/track`

Records something a person did in your app and starts or advances the automations listening for it. Pass phone, user_id, or both; a call with both links them so later events need only user_id. Test keys reach sandbox automations, live keys live ones. Supports Idempotency-Key. 100 calls per 10 seconds per key. Scope: automations. (GET /events is the webhook event log, a different thing.)

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | At most 255 characters. |

## Request body

JSON (`Content-Type: application/json`).

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | string | Yes | Letters, digits, and _ . : - At most 64 characters. Example: `trial_started`. |
| `user_id` | string | No | At most 128 characters. Example: `123`. |
| `phone` | string | No | Example: `+14155550132`. |
| `properties` | object | No | Up to 20 scalar values; usable as merge fields and in conditions. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 201 | Recorded | `TrackedEvent` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 201: `TrackedEvent` fields

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `tev_a1B2c3D4e5F6g7H8`. |
| `object` | `tracked_event` |  |
| `event` | string |  |
| `user_id` | string | Nullable. |
| `phone` | string | Null when user_id is not linked to a number yet (nothing could start). Nullable. |
| `properties` | object |  |
| `test` | boolean |  |
| `runs_started` | array of string | Ids of the runs this event started. |
| `runs_notified` | integer | Runs in progress for this person that recorded the event. |
| `created_at` | string (date-time) |  |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Idempotency

Send an `Idempotency-Key` header to make retries safe. For 24 hours the same key with the same body replays the original successful response (with `Idempotent-Replayed: true`); the same key with a different body returns 409. A failed request releases its key.

## Examples

### Node.js

```javascript
import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

await sms.events.track({
  event: 'order_placed',
  phone: '+14155550132',
  properties: { order_id: 'A-1042' },
});
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/track');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'event' => 'trial_started',
        'user_id' => '123',
        'phone' => '+14155550132',
        'properties' => [
            'plan' => 'pro',
        ],
    ]),
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

```python
import os
from jointextkit import TextKit  # pip install jointextkit

client = TextKit(os.environ["TEXTKIT_API_KEY"])

client.events.track(
    "order_placed",
    phone="+14155550132",
    properties={"order_id": "A-1042"},
)
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/track")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"
req["Content-Type"] = "application/json"
req.body = {
  "event": "trial_started",
  "user_id": "123",
  "phone": "+14155550132",
  "properties": {
    "plan": "pro"
  }
}.to_json

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "event": "trial_started",
	  "user_id": "123",
	  "phone": "+14155550132",
	  "properties": {
	    "plan": "pro"
	  }
	}`)
	req, _ := http.NewRequest("POST", "https://api.jointextkit.com/v1/track", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(data))
}
```

### Rust

```rust
// cargo add reqwest --features blocking,json
// cargo add serde_json
use serde_json::json;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .post("https://api.jointextkit.com/v1/track")
        .bearer_auth(key)
        .json(&json!({
          "event": "trial_started",
          "user_id": "123",
          "phone": "+14155550132",
          "properties": {
            "plan": "pro"
          }
        }))
        .send()?
        .error_for_status()?;
    let data: serde_json::Value = res.json()?;
    println!("{data}");
    Ok(())
}
```

### Java

```java
import java.net.URI;
import java.net.http.*;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/track"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "event": "trial_started",
                  "user_id": "123",
                  "phone": "+14155550132",
                  "properties": {
                    "plan": "pro"
                  }
                }
                """))
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

### .NET

```csharp
using System.Net.Http.Headers;
using System.Text;

var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY"));

var body = new StringContent("""
    {
      "event": "trial_started",
      "user_id": "123",
      "phone": "+14155550132",
      "properties": {
        "plan": "pro"
      }
    }
    """, Encoding.UTF8, "application/json");
var res = await http.PostAsync("https://api.jointextkit.com/v1/track", body);
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X POST "https://api.jointextkit.com/v1/track" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2f0e-order-1042" \
  -d '{
  "event": "trial_started",
  "user_id": "123",
  "phone": "+14155550132",
  "properties": {
    "plan": "pro"
  }
}'
```

## Related

- Guide: [Automations](/docs/automations)
- [All tracked events endpoints](/docs/api#track)
- [API reference](/docs/api)