INinfobip
customer-engagement
people
events

Create Event Definition

Create a new custom event definition either from scratch or from a template. When creating from scratch, specify a unique definition ID (alphanumeric only, max 36 characters), title, description, and up to 120 fields. When using a template, only provide the template ID and optional additional fields—the title, description, and default fields are inherited from the template. Supports various field types including String, Boolean, DateTime, Numeric, Decimal, and List (with nested object schema).

post/peopleevents/2/definitions

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

Request body

templateIdstring nullable

Template identifier. Used when the client wants to create a definition from a template. Must contain only alphanumeric characters (a–z, A–Z, 0–9). Maximum length: 36 characters. Must be null if definitionId is provided.

definitionIdstring nullable

Event definition identifier. Must contain only alphanumeric characters (a–z, A–Z, 0–9). Maximum length: 36 characters. Must be null if templateId is provided. Cannot have a value from the list of predefined (standard) definitions.

titlestring nullable

Event definition title. Required if templateId is null. Maximum length: 100 characters. Must be null if templateId is provided.

descriptionstring nullable

Event definition description. Maximum length: 2000 characters if templateId is null. Must be null if templateId is provided.

Response

Successfully created

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.