Rest Trigger

With the Rest Trigger, you can execute the integration flow by means of an external call with one of the HTTP methods.

The configuration form contains two sections: INFORMATION and REQUIREMENTS.


In the INFORMATION section, you will see the following fields:

  • Name: this field contains the trigger’s default name. It is editable and the name cannot be used more than once in the same integration flow.

  • Method: field to select the HTTP method to be used. The HTTP methods available are:

    • delete;

    • get;

    • head;

    • options;

    • patch;

    • post;

    • put.

By default, the field will be blank.

  • Communication Type: field to define if the call will be synchronous (SYNC) or asynchronous (ASYNC). By default, the SYNC option will be selected.

For an asynchronous call, the system will return a 202 response.

The REQUIREMENTS section contains the HEADER and QUERY components for mapping input data.

  • Key: field to insert the Header parameters.

    • alphanumeric;

    • allows the characters _, . and -;

    • 60 characters maximum.

  • Key: field to insert the Query parameters.

    • alphanumeric;

    • allows the characters _, . and -;

    • 60 characters maximum.

You cannot register the same key more than once.

To delete a key in any of the components, click the trash can icon on the right of the key.

To add a new key, click the + icon next to trash can.

Payload definition

To define the structure of the input payload, click PAYLOAD DEFINITION at the top right of the Rest Trigger screen.

Mapping the structure of the input payload in the Rest Trigger component will make it easier to use the mapped fields in other components of the integration flow.

In the window that opens, there are two columns:

  • JSON SCHEMA: inform the JSON schema to define the structure that will be passed in the incoming request. There is no limit of characters. To validate the format of the data and visualize it in the JSON STRUCTURE column, click the update icon on the right update icon.

  • JSON STRUCTURE: read-only.

configurando payload

You can edit the payload definitions at any time during the creation of the integration flow.

If you have already created a JSON schema, when you click PAYLOAD DEFINITION, you will see the data previously registered.

To delete an attribute from the payload definition, delete the corresponding line from the JSON schema column.

To confirm the data, click CONFIRM.

If the JSON schema is not in the correct format, you will see a message that the JSON schema is invalid.

To exit without saving, click CANCEL.

For more information on the JSON schema specification and on how to build a validation file according to your needs, access JSON SCHEMA.

When you finish the payload definitions and return to the Rest Trigger configuration screen, click SAVE to save the information you registered.

To exit the screen without saving, click X.

To delete the trigger, select the respective icon on the canvas and click the trash can.

Deleting the Rest Trigger disables the TEST MODE function.
Thanks for your feedback!
How useful was this article to you?