Importing custom events

Requirements


  • User permissions to conduct such a data update.
  • The business profile API key must allow conducting imports.
  • Prepare a file according to the instructions:
    • The file must contain a column with a customer identifier and at least one parameter of the imported custom event.
    • Spaces and special characters in the column headers are not allowed.
    • The file cannot contain empty fields. If you want to leave empty fields, enter the null value.
Image presents the example of file
Image presents the example of the file
Important: The table below contains events which, as a result of being imported to the application, create customer profiles.
  • client.register
  • appSystemInfo.log
  • facebook.fanpagePost
  • form.submit
  • message.receive
  • application.started
  • message.send
  • facebook.postReaction
  • screen.view
  • facebook.postComment

Procedure


  1. Go to Settings icon Settings > Import > New import.

  2. Choose the Custom import as the type of the import.

    Important: It’s necessary to select Custom import instead of Custom events because the Custom events type is only meant for importing single events.

  3. Choose the method of import.

  4. Only for Pull imports: To define the access to your SFTP, in the Access section click the Define button. When you adjust the settings, confirm with the Apply button.

  5. Only for Pull imports: To define the frequency of imports, in the Schedule section click the Define button and adjust the settings. Confirm them with the Apply button.

  6. To upload a file with the data to be imported, in the Sample file section click the Define button.

    Important:
    • If you have chosen the File upload as the method of import, the file you upload here is is imported immediately after saving the import.
    • If you have chosen the Pull method, the file you upload here is just a sample file, and the file from SFTP is imported at the time you scheduled.
    • In the case of the Push method, the file you upload here is just a sample file. More information about the import flow for every method is available at the link.

    • Choose the type of the file you are going to import.
    • To upload the file, click the + Upload file or drop one here button.
    • Confirm the action by clicking the Apply button.
  7. To proceed to the next step, click the Next button.

    The file before mapping
    The file before mapping
  8. On the left side of the screen, click Add endpoint.

  9. Select the Events batch option.
    Result: A list of parameters to map appears.

  10. Map the parameters. On the left side of the screen, in the Required list, locate the parameter that corresponds to the customer identifier column and drag a line from the parameter to the column.

  11. Above the table, click the Add column button.

    1. In the Column name field, enter action.
    2. In the Plain text field, type the name of the event (for example, product.availability).
    3. Confirm the settings by clicking Save.
      Result: A new action column appeared with the event name as a value for each row.
    4. From the Required list, drag a line from the Action parameter to the action column.
      Result: The action column is mapped.
  12. Above the table, click the Add column button.

    1. In the Column name field, enter label.
    2. In the Plain text field, type the short description of the event (for example, the availability of product in the store).
    3. Confirm the settings by clicking Save.
      Result: A new label column appears with the event description as a value for each row.
    4. From the Required list, drag a line from the Label parameter to the label column.
      Result: The Label column is mapped.
  13. If your file contains columns with the parameters that are not available neither in the Required nor the Optional section, to be able to map these, you need to create the parameters on the list.

    1. Click the Add field button on the bottom of the list.
    2. Start the name of the field with the params. prefix.
    3. The part after params. must contain the name of the column you want to connect (for example, params.campaignName).
      WARNING: Remember to enter the exact name of the column after the params. part, it’s case sensitive.

      Result: In the Optional list, a parameter shows up. To see it, you need to unfold the list by clicking the icon next to Optional.
    4. In the Optional list, find the newly added parameter and connect it with the appropriate column.
    5. If needed, add more parameters in the same way.
  14. At the bottom of the list, click the Add column button.

  15. Required only for batch imports of custom events: In the Column name field, enter type.

  16. In the Plain text field, enter custom.

  17. Confirm the settings by clicking Save.
    Result: The type column appears.

  18. Click the Add field button. Result: Next to the button, a field appears.

  19. Enter type.
    Result: In the Optional list, a parameter appears. To see it, you need to expand the list by clicking the arrow icon next to Optional.

  20. Connect the type parameter with the type column.

    The file after mapping
    The file after mapping
  21. To proceed, click the Next button.

  22. Verify the mapping of the fields.

  23. To complete the process, click the Save button.
    Result: Only for Push method imports: the Save button saves the mapping, and you get the webhook URL to send the data. You can reuse this mapping later for importing CSV files. To do so, go to the list of imports, and click the import. Click the Import data from CSV file. The structure of the file (number of columns, name of the columns, and the data format) must be the same.

Important:

Depending on the import method you have chosen in the step 3, the flow of the import will vary.

  • If you have chosen File upload method, the Save button completes the process. The import is processed immediately.
  • If you have chosen Pull method, the Save button completes the process and the import will be processed at the scheduled time.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.