Create a script

You can integrate custom scripts in your business logic. Depending on your use case, there are different script types with different context properties.


We recommend that you keep the total script runtime below 10 minutes. After 12 minutes, the script worker considers the script stuck and starts a new worker to relaunch it. This can cause resource starvation and data inconsistency.

To create a script:

  1. On the menu bar, click Manage cog icon.

  2. On the Manage page, click Scripts.

  3. On the Scripts page, click Plus icon Script.

  4. In the Script dialog, enter a name and a description and select a script type. Options are:

    • Action script.

    • Metadata processing script.

    • User pre-registration script.

    • User post-registration script.

    • User sign-in script.

    • Shared script.

  5. Click Save.

  6. On the Scripts page, click the new script.

  7. Click Edit in the upper left-hand corner.

  8. Optionally, in the right-hand pane, click Edit icon and select a log level from the Minimum log level drop-down menu. By default, the minimum log level is not set and displays None. This defaults to the Info log level in the SDK.


    When using scripting, it is not possible to change the minimum log level on the default IMClient.Logger. Change the minimum log level from the UI instead.


    The maximum limit of log entries per script is 50.

  9. Enter your script code in the text area, then click Build.

  10. If the script builds without errors, click Done. If not, fix the errors and build again.

  11. To apply your code changes, click Publish.

  12. To enable your script, on the Scripts page, next to your script, turn on the Enable control switch.

Do you have some feedback for us?

If you have suggestions for improving this article,