INinfobip
customer-engagement
people
events

List Event Definitions

Retrieve a paginated list of event definitions, including standard, custom, and template definitions. Use query parameters to filter by category (External, Person, Channel, Product, Template) or search by definition ID, title, or description. Results can be ordered by definition ID or title.

get/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

Query parameters

offsetinteger

A pagination parameter that specifies the number of records to skip before starting to return results.

limitinteger

A pagination parameter that specifies the maximum number of records to return in a single response.

orderType'Asc' | 'Desc'

Sort direction for results.

Defines the sort direction for the results.<br>Note: If orderField is not provided, this parameter will not have any effect.

orderField'DefinitionId' | 'Title'

Field by which results should be ordered.

Specifies the field by which the results should be ordered.<br>Note: If orderType is not provided, ordering will not work.

categoryFadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864EventDefinitionCategory[]

Filters results by one or more event definition categories.

searchTextstring

Text used for searching event definitions by definition ID, title, or description.

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.