Collections can be created from within the Permutive dashboard. This allows users to create a new event collection with custom properties at any point in the user journey (eg. user signed up, affiliate link clicked etc)

Add a Collection

To add a new collection, head to Events → '+Add Collection'

And add the required information

Name - How the name that will appear in the 'Events' tab
Description - Add a description on what the event will collect
Source - The method you will use to track the new event

Properties - The properties that will be included in the new event.

Six standard properties are collected via the Web Source:

  • Client domain - domain the user was on when the event occurred
  • Client referrer - where the user arrived from (eg. Google)
  • Client title - the page title that appears in the browser tab
  • Client type - eg. web/fia/amp/ios/android
  • Client url - url the user was on when the event occurred
  • Client user agent - browser/device the user was on when event occured

One standard property is collected via the iOS and API Sources:

  • Client type - eg. web/fia/amp/ios/android

Add a Property

By selecting '+Property', you can add any number of custom properties to your event

Name - The human-readable name that will appear in the new event
ID - How the property will appear in the new collection (JSON)
Description - Add a description of what the property will collect
Type - eg. Integer, Float, String. The event will be rejected if the type cannot be classified, so it is important you set the correct 'type'.
Required - If toggled 'on' (green), the property will need to be collected for the event not to be rejected (if passed in 'null', the event will be rejected). We recommend leaving this 'off'.

Select OK →  Create to save the new event. Once the schema has been created, work with a developer to send in the relevant properties via the correct Source (Web, iOS, API).


  • If using the API Source to collect a new event, the resulting collection cannot be used in segmentation.
  • One saved, a user cannot delete an event or it's relating properties. 

Please contact if you have any questions.

Did this answer your question?