Define responses

Edit online

When you finish defining all the information that is required to use an action, you need to define what the user sees when the action is completed.

Note: If you used the Create an action using GenAI option to create an action, some parameters in the response tab are automatically prefilled by the generative AI.

To update the response tab, complete the following steps:

  1. From the Connector Development Kit home page, click the connector that you want to work with.

  2. Go to the Actions tab, then select the action that you want to work with.

  3. Click the Response tab.

    In the Response properties section you can see all the response properties that are displayed when the action is completed.

  4. (Optional) If you created a connector from scratch, in the Success response section, use the Response code arrow to select a response code:

    Response code Description
    200 Success. Indicates that the request succeeded.
    201 Created. Indicates that the request succeeded and that a resource is created.
    202 Accepted. Indicates that the request was accepted for processing, but the processing is not complete.

  5. To add or remove any properties that you don't want in the response, click Add or remove.

    The Add or remove properties side panel is displayed.

  6. In the Add or remove properties side panel, use the radio buttons to choose whether you want to select properties from the existing schema or create a new schema.

    • Select existing schema. To use this option, select or deselect the properties as required.

    • Create schema. To use this option, provide a name for the schema and paste or write the JSON payload into the field provided.

      • Ensure that the field contains a valid JSON object. You cannot use the schema until invalid formatting is corrected. Invalid JSON is underlined in red. Hover over the red line to view the problem.
      • The following screen capture illustrates a valid JSON object.

      Response schema example

  7. Click Apply changes.

    Tip: If your response property structure is complex with one or more nested properties, use the Response starting point radio button to define where the response property begins when the action is run. If you choose the 'RetrieveWithWhere' action type, you can only select array properties. For all other action types, you can select both objects and simple properties (nonarray) that are at the first level.