Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring inputs for an automation

Updated on April 6, 2022

Define specific inputs in an automation rule to create a contract so that users understand how to use your API. The inputs define the data that the system expects to receive from an external application.

  1. Create a new automation or open an existing automation.
    Create a new automationFollow the steps in Creating an automation.
    Open an existing automation
    1. In the navigation pane of Dev Studio, click Records.
    2. Expand the Technical category and click Activity.
    3. Locate the automation for which you want to simulate a JSON response and click in its row.
      Automations have the AUTOMATION activity type.
  2. On the Definition tab, in the Inputs section, in the Name field, enter a name for the input.
    For example: Case ID.
    Result: The system automatically populates the ID field with the name that you enter in the Name field.
  3. Optional: Edit the name in the ID field.
  4. In the Description field, enter a description of the input parameter.
  5. In the Data type field, select the data type of the input parameter.
  6. Configure the input parameter based on the data type that you selected in step 5.
    Data typeConfiguration
    • Date only
    • Date & time
    • Time only
    • Decimal
    • Boolean
    • Integer
    1. Optional: To indicate that this input is a requirement, select the check box in the Required column.
    2. Click the Gear icon.
    3. In the configuration dialog box, in the Default value field, enter a default value to use if the system cannot find a value for the input.
    4. Click Submit.
    TextFor more information on configuring text inputs, see Configuring validation for text inputs and outputs in automations.
    • Page
    • Page List
    1. In the Options / Page class field, enter or select the class to which this input belongs.
    2. Optional: To indicate that this input is a requirement, select the check box in the Required column.
    Resource Page
    Note: You can only configure one input as a Resource Page. The page class must be the same as the class to which the automation belongs. Resource Page inputs are required. The system calls the implementation activity on the resource page.
  7. Optional: To add additional inputs, click Add input.
  8. Optional: To delete an input, click Delete.
  9. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us