Send single event

Use the Send Event API to ingest events from your application into BIK.

Request parameters

info

Either email or phoneNumber must be provided; both cannot be empty at the same time.

Name	Type	Required/Optional	Description
event	Event	Required	Event object to ingest

Event Type

Name	Type	Required/Optional	Description
name	string	Optional	Customer name
phoneNumber	string	Optional	Customer phone number
email	string	Optional	Customer email address
eventName	string	Required	Event name
eventProperties	[key: string]: string or number or boolean or object	Required	Key-value pairs describing the event
createdAt	string	Optional	ISO 8601 timestamp of the original event. Defaults to ingestion time if omitted.
isMigration	boolean	Optional	Set to true to route through the historical migration pipeline. Defaults to false.

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-events/sendEvent

Sample request

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-events/sendEvent' \
--header 'Authorization: Basic AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": {
        "name": "Name",
        "email": "test@bik.ai",
        "phoneNumber": "+19494572787",
        "eventName": "purchasedAProduct",
        "eventProperties": {
            "productId": "PRODUCT_ID",
            "orderId": "test-order-id1234",
            "orderName": "my-order",
            "productName": "my-product",
            "itemPrice": 500,
            "currency": "INR",
            "customerId": "CUST_TEST_123",
            "variantId": "1234567890"
        }
    }
}'

JSON response example:

{
  "status": 200,
  "success": true
}

Response parameters

Name	Type	Description
status	number	HTTP status code
success	boolean	Indicates whether the request succeeded

Errors

Error Code	Meaning
400	Invalid payload -- Your request is invalid.
401	Unauthorized -- User is not authenticated.
404	Not Found -- The specified API could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.

Error response example:

{
  "status": 400,
  "errors": [
    {
      "message": "'eventProperties.variantId' is required"
    }
  ]
}

Historical Data Migration

By default, events are processed in real time. To backfill historical data, set "isMigration": true in the event payload — this routes it through a separate low-priority pipeline that preserves the original createdAt timestamp.

Scenario	isMigration	createdAt	Result
Normal real-time event	false / omitted	omitted	Ingestion time used, goes to real-time stream
Historical event	true	"2024-11-15T..."	Supplied date preserved, routed to migration pipeline
Historical event, no date	true	omitted	Ingestion time used, still routed to migration pipeline
Back-date only, no flag	false / omitted	"2024-11-15T..."	Date preserved but goes to real-time stream — will be rejected by data stream

danger

Always set both isMigration: true and createdAt together when pushing historical data.

---

Note: BIK does not currently support custom event ingestion.