Compat

Track an event for a person (Customer.io)

POST/v1/compat/customerio/api/v1/customers/{identifier}/events

Requires an API key with the contacts:write events:write scope. About keys and scopes

Customer.io's Track API v1, so an app sending to Customer.io can send here too while it moves, by pointing its client at …/v1/compat/customerio. Authenticate as Customer.io clients do, with HTTP Basic: any site id as the user and an Kirora API key as the password (a Bearer key works too). The identifier is the contact's externalId, or its email when it holds an @. first_name, last_name, email and phone fill those fields, unsubscribed: true withdraws email consent, and every other key becomes an attribute. Consent is never granted here: import it with its evidence. Agent keys are refused. A person not yet known is created first.

Requires API-key scope: contacts:write and events:write.

Path parameters

identifierstringrequired: 1–255 characters

Request body

namestringrequired: 1–128 characters
dataobjectoptional
timestampintegeroptional: min > 0 · max 9007199254740991
idstringoptional: 1–255 characters

Returns

Returns 200 OK. Otherwise returns an error; Errors lists every code and which to retry.

curl -X POST https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example/events \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekend specials"
  }'

const response = await fetch('https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example/events', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Weekend specials"
  }),
});
const { data } = await response.json();

import os

import requests

response = requests.post(
    "https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example/events",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
    json={
        "name": "Weekend specials",
    },
)
data = response.json()["data"]

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	body := []byte(`{
	  "name": "Weekend specials"
	}`)
	req, err := http.NewRequest("POST", "https://api.kirora.io/v1/compat/customerio/api/v1/customers/identifier_example/events", bytes.NewReader(body))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{}

Example values are generated from the schema.