Track Lead

Endpoint

POST https://track.taap.it/api/events/lead

Authentication

Server-side (Recommended)
Client-side

Use your secret API key:

Authorization: Bearer taapit_sk_xxxxxxxxxxxx

Use your publishable key:

X-Publishable-Key: taapit_pk_xxxxxxxxxxxx

Request Body

Field	Type	Required	Description
`trackingId`	string	✓	The `ta_tid` from the cookie or URL parameter
`customer`	object	✓	Customer information
`customer.externalId`	string	✓	Your internal user/customer ID
`customer.email`	string		Customer’s email address
`customer.firstname`	string		Customer’s first name
`customer.lastname`	string		Customer’s last name
`customer.phoneNumber`	string		Customer’s phone number
`customer.avatarUrl`	string		URL to customer’s avatar image
`metadata`	object		Additional custom data (key-value pairs)

Examples

cURL
Node.js SDK
React Hook
JavaScript

curl -X POST https://track.taap.it/api/events/lead \
  -H "Authorization: Bearer taapit_sk_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "trackingId": "rLnWe1uz9t282v7g",
    "customer": {
      "externalId": "user_123",
      "email": "[email protected]",
      "firstname": "John",
      "lastname": "Doe"
    },
    "metadata": {
      "source": "signup-form"
    }
  }'

import { Taapit } from 'taapit-sdk';

const taapit = new Taapit({
  apiKey: process.env.TAAPIT_API_KEY,
});

await taapit.track.lead({
  trackingId: 'rLnWe1uz9t282v7g',
  customer: {
    externalId: 'user_123',
    email: '[email protected]',
    firstname: 'John',
    lastname: 'Doe',
  },
  metadata: {
    source: 'signup-form',
  },
});

import { useTaapitAnalytics } from 'taapit-sdk/react';

function SignUpForm() {
  const { trackLead } = useTaapitAnalytics();

  const handleSignUp = async (user) => {
    trackLead({
      customer: {
        externalId: user.id,
        email: user.email,
        firstname: user.firstName,
        lastname: user.lastName,
      },
      metadata: {
        source: 'signup-form',
      },
    });
  };
}

<script src="https://taap.it/api/sdk" data-publishable-key="taapit_pk_xxx"></script>

<script>
  taapit.trackLead({
    customer: {
      externalId: 'user_123',
      email: '[email protected]',
      firstname: 'John',
      lastname: 'Doe',
    },
    metadata: {
      source: 'signup-form',
    },
  });
</script>

Response

200 OK
400 Bad Request
401 Unauthorized
404 Not Found

{
  "ok": true
}

{
  "error": "Missing customer.externalId"
}

{
  "error": "Invalid API key"
}

{
  "error": "Click not found for this trackingId"
}

Error Codes

HTTP Code	Error	Description
400	`Invalid payload`	Request body validation failed
400	`Missing customer.externalId`	Required field not provided
401	`Invalid API key`	API key is invalid or revoked
401	`Hostname not in allowed list`	Origin not whitelisted (client-side)
403	`This click does not belong to your workspace`	trackingId is for a different workspace
404	`Click not found for this trackingId`	trackingId doesn’t exist or has expired

Getting started

Conversions

API Reference

Endpoint

Authentication

Request Body

Examples

Response

Error Codes

Getting started

Conversions

API Reference

​Endpoint

​Authentication

​Request Body

​Examples

​Response

​Error Codes

Endpoint

Authentication

Request Body

Examples

Response

Error Codes