Log inTry for free
Back to all APIs

Send Event

Use this endpoint to track events that persons perform. Your request must refer to existing person profile and event definition.

Please log in to see full path URL. Learn why.
post
/peopleevents/2/persons/{personId}/definitions/{definitionId}/events
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
people:manage
people:use
web:sdk
Request rate limit:
250 requests / second (per account)
path Parameters
definitionId
required
string

Identifier of the custom event definition (Event ID). Event properties are passed in the request body.

personId
required
string

Identifier of the person who performed the event. The identifierType query parameter specifies the type of the ID.

query Parameters
identifierType
required
string
Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "WEB_PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "GOOGLE_BUSINESS_MESSAGES"

Person's identifier type.

Request Body schema:
application/json-patch+json
collapse all -
properties
object or null

Object that contains event payload. The properties must match the schema that was configured in the event definition for the corresponding definition ID.

Responses

201

Successfully created

400

Invalid resource representation

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Request samples

Content type
application/json-patch+json
Copy
 Collapse all
{
  • "properties":
    {
    • "transactionId": "my-transaction-1",
    • "fromPromoCampaign": true,
    • "totalCost": 100,
    • "itemsInCart":
      [
      • {
        • "itemId": 1,
        • "price": 25,
        • "quantity": 3,
        • "inStockSince": "2023-11-17T15:47:50.4136517Z",
        • "category": "clothes"
        },
      • {
        • "itemId": 2,
        • "price": 25,
        • "quantity": 1,
        • "inStockSince": "2023-12-17T15:47:50.4138054Z",
        • "category": "shoes"
        }
      ]
    }
}

Response samples

Content type
text/plain
Copy
{
  "eventId": "EFDB662A-F0BD-4064-8F49-16C0C1C48AD2",
  "definitionId": "addToCart",
  "occurredTime": "2024-05-17T15:47:50.4139152Z",
  "properties": {
    "transactionId": "my-transaction-1",
    "fromPromoCampaign": true,
    "totalCost": 100,
    "itemsInCart": [
      {
        "itemId": 1,
        "price": 25,
        "quantity": 3,
        "inStockSince": "2023-11-17T15:47:50.4136517Z",
        "category": "clothes"
      },
      {
        "itemId": 2,
        "price": 25,
        "quantity": 1,
        "inStockSince": "2023-12-17T15:47:50.4138054Z",
        "category": "shoes"
      }
    ]
  },
  "metadata": {
    "source": "API"
  }
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use