Custom Integration Element
A Custom Integration element is a UI component that integrates a third-party service or API into a website or application.
Custom integrations can provide many benefits, such as increased functionality, improved user experience, and access to valuable data and insights. However, it's important to consider the security and reliability of the third-party platform being integrated, as well as any potential costs or limitations associated with the integration.
- API Name: The name of the API that is being created is mentioned here.
- URL: The URL to run the API (Request URL).
- UploadΒ JSON File: Here we upload the custom input in JSON format for the API that we want to create. After uploading the JSON file, we can also see the uploaded data by clicking on the Open JSON Editor button. This JSON file can also be downloaded or a new file can be re-uploaded.
- Request PreProcess: When we want to add an additional Request before hitting the API we can configure it by selectingΒ βOpen Code Editorβ. Then we can use the editor to do the needful.
- Response PreProcess: When we want to customize the Response after triggering the API we can configure it by selectingΒ βOpen Code Editorβ. Then we can use the editor to do the needful.
- Response Array Handling: This field has five trigger points option(On Page Load, On Page Submit, When variable's value exists, When variable's value is defined, On Button Click) which we can Configure according to our requirements.
- On Page Load: In this, the integration will be triggered when the page loads.
- On Page Submit: In this, the integration will be triggered when the page is submitted.
- When variable's value exists: In this, the integration will be triggered when the selected variable's value exists. This variable can be chosen from the dropdown.
- When variable's value is defined: In this, the integration will be triggered when the selected variable's value is equal to the value defined by the user. This variable can be chosen from the dropdown and then the value can be configured.
- On Button Click: In this, the integration will be triggered when the button is clicked. The button text can also be configured here.
Error messages for each scenario, viz, error 401, error 404, error 409, error 500, and other errors can be configured in the specified boxes. Right now the integration layer only gives 400 to our console so to get the proper error codes to check this out, you can configure N8N workflow to get all error codes.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].
ο»Ώ