INinfobip
customer-engagement
people
events

Send Event

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

post/peopleevents/2/persons/{personId}/definitions/{definitionId}/events

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or API key in header Authorization
    • or API key in header Authorization
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

definitionIdstring required

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

personIdstring required

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

Query parameters

identifierType'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' | 'WHATSAPP' | 'ZALO_FOLLOWER' | 'TIKTOK_BM' required

Person's identifier type.

createPersonboolean

Set this parameter to true to automatically create a person profile with the specified personId and identifierType if no existing profile matches the provided identifier. The default value is false.<br>Note: New profiles can only be created for the following identifier types: PHONE, EMAIL, or EXTERNAL_ID.

Request body

eventIdstring nullable

Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same eventId ensures the event is only recorded once in the person profile.<br>The value must be 1–36 characters long and can include letters (A–Z, a–z), digits (0–9), underscores (_), and hyphens (-) only.

propertiesobject nullable

Object containing event properties. Must match the corresponding event definition. See People Events documentation for supported data types.

interactionIdstring nullable

Identifier that correlates the event with a specific interaction (for example, a journey or a conversation). When provided, it is stored in the event metadata and can be used to match the event to the interaction it belongs to.

Response

Successfully created

eventIdstring

Unique identifier of the event.

definitionIdstring

Unique identifier of event schema.

occurredTimestring date-time

Time of event occurrence, as the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

propertiesobject nullable

Object that contains event properties.

metadataobject nullable

Object that contains metadata of event occurrence.

Example response

{
  "occurredTime": "2024-05-17T15:47:50.413Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.