v.1.3

Events

Records activities (events) performed by user profiles.

Request Headers

Header

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
x-api-key	{your-api-key}	Yes

Request Body

The request body should contain an array of event objects. Each event object must include the required attributes and can contain any additional custom attributes as needed.

[
  {
    "app_id": "your_app_id",
    "profile_id": "user123",
    "event": "login",
    "urm_date_time": "2024-10-28T10:15:30.225Z",
    "urm_ip": "192.168.1.1",
    "login_method": "email",
    "device_type": "mobile",
    "os_version": "iOS 18.0.1"
  },
  {
    "app_id": "your_app_id",
    "profile_id": "user456",
    "event": "purchase",
    "urm_date_time": "2024-10-28T11:22:45.781Z",
    "urm_ip": "192.168.1.2",
    "product_id": "prod-789",
    "amount": 99.99,
    "currency": "USD",
    "payment_method": "credit_card"
  }
]

Attributes

Attribute	Type	Required	Description
app_id	String	Yes	Unique identifier for your application provided by your Account Manager
profile_id	String	Yes	Unique identifier for the user profile
urm_date_time	Date String	Yes	ISO 8601 formatted timestamp of the profile creation/update
urm_insert_id	String	Yes	Unique identifier for the inserted record. If not provided, the system automatically generates a random value starting with "urm-"
urm_ip	String	No	IP address of the user

Custom Attributes

You can include any additional custom attributes in the event object according to your business needs. These attributes can be of any supported data type (String, Number, Boolean, Date String, or Array).

Important Restriction: Custom attribute names must not start with "urm" (case-insensitive). Attribute names like "urm_custom", "URM_field", or "uRmData" will be rejected. The "urm_" prefix is reserved for system attributes.

‍

Code Snippet

curl -X POST "https://api.rapidpacecrm.com/events" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-api-key: your_api_key" \
  -d '[
    {
      "app_id": "your_app_id",
      "profile_id": "user123",
      "event": "login",
      "urm_date_time": "2024-10-28T10:15:30.225Z",
      "urm_ip": "192.168.1.1",
      "login_method": "email"
    }
  ]'

‍

Response

Success Response (200 OK)

{
  "EncryptionType": "KMS",
  "FailedRecordCount": 0,
  "Records": [
    {
      "SequenceNumber": "sequence_number_value",
      "ShardId": "shardId-ID"
    }
  ]
}

Error Response (400 Bad Request)

{
    "message": "Invalid request body"
}

Error Response (403 Forbidden)

{
    "message": "Forbidden"
}