customer-engagement
people
events

Get Event Definition

Retrieve complete details of a specific event definition, including its fields, data types, category, and whether it's a standard or custom definition. Useful for understanding the schema before sending events or for validating your event data structure.

get/peopleevents/2/definitions/{definitionId}

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

Event definition identifier.

Response

OK

isInternalDefinitionboolean

Indicates whether this is a standard (internal) event definition provided by the system, or a custom (external) definition created by the user.

category'external' | 'person' | 'channel' | 'product' | 'template'

Event definition category.

subcategory'sms' | 'email' | 'push' | 'whatsapp' | 'viber' | 'facebook' | 'moments' | 'forms' | 'conversations' | 'mobileapp' | 'voice' | 'line' | 'appleBC' | 'rcs' | 'mms' | 'viberBot' | 'inapp' | 'answers' | 'blocklist'

Event definition subcategory.

definitionIdstring nullable

Event definition identifier.

titlestring nullable

Event definition title.

descriptionstring nullable

Event definition description.

Changes

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