Skip to main content
POST
/
stores
/
{storeId}
/
events
curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_name": "purchase_milestone_reached",
  "phone": "+12065551234",
  "properties": {
    "milestone_type": "100th_purchase",
    "total_spent": 5000,
    "vip_tier": "gold"
  }
}
'
{
  "event_id": "<string>",
  "event_name": "<string>",
  "status": "processed"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json

Custom event to trigger flows with merchant-defined event names and properties.

​
event_name
string
required

The name of the custom event (e.g., 'user_registered', 'purchase_completed').

​
email
string

Customer email address (one of email or phone is required).

​
event_timestamp
string<date-time>

ISO 8601 timestamp when the event occurred. Defaults to current time if not provided.

​
phone
string

Customer phone number (one of email or phone is required).

​
properties
object

Custom properties for this event. Access in templates using dot notation (e.g., {{ properties.product_name }}).

Response

Event created successfully

Response after successfully creating a custom event.

​
event_id
string
required

The unique identifier for the created event.

​
event_name
string
required

The name of the custom event that was created.

​
status
enum<string>
required

Status of the event processing.

Available options:
processed