Sections
Profile

Integrations

on 05-14-2024 12:00 AM by SnapApp by BlueVector AI

1083

Integrations enable SnapApp to interact with the outside world, allowing it to send or retrieve data from external sources.

There are 5 different types of Integrations:

  • FTP Inbound - To fetch a file form an external source.
  • FTP Outbound - To send a file to an external source.
  • Inbound Webhook - To fetch data from an external source.
  • Outbound Webhook - To send data to an external source.
  • Expression - To use expressions for processing data.
  • GCS Inbound - To fetch data from GCS.

Table of Contents

Create an Integration

  1. Open Settings from the User menu.

    Open-settings

  2. Select Integrations from the Automation dropdown menu.

    Templates-Dropdown

  3. Click + Add New in the top header of the Integrations list view to add a new Template.

    Add-New

  4. Fill out the required fields and hit Save.

    Fill-Required-Fields

  5. List view of the integrations will be shown.

    Template-Detail-View

Configuration of an Integration

  1. Create a new Integration
  2. Update the following settings
Setting Description
Name The name of the integration to be displayed in lists
Object Id The Object identifier on which the integration should be called
Active Integration active or inactive status
Types Types of integration. Can be Expression, FTP Outbound, FTP Inbound, Inbound Webhook, Outbound Webhook or GCS Inbound
Expression Name If type is expression, the name of the expression
Expression Type If type is expression, the type of the expression
Space URL If expression type is Hugging Face Space, the URL of the space
Space Endpoint If expression type is Hugging Face Space, the endpoint to hit
User Username on the host
Password The password for the user
Port If type is FTP Outbound or Inbound, the port to trigger
Host If type is FTP Outbound or Inbound, the host URL
Field ID If type is FTP Outbound, the ID of file field
Destination File Path If type is FTP Outbound, path to the destination
Pickup File Path If type is FTP Inbound, path where file is present on host
Response Action If type is FTP Outbound/Inbound or Outbound/Inbound Webhook, workflow to trigger on response
URL If type is Outbound Webhook, webhook URL
Methods If type is Outbound Webhook, the HTTP or HTTPS method to use
Header If type is Outbound Webhook, list of key and value pair for the request header
Authorization Type If type is Outbound Webhook, the authorization type for the request
Request Body If type is Inbound and Outbound Webhook, JSON schema for the request body
Response Body If type is Outbound Webhook, JSON schema is there for the response body
App If type is Inbound Webhook, integration application
File Type If type is GCS Inbound, Can be a File or Document AI
Parser Name If file type is Document AI, the parser to use
Source Bucket If type is GCS Inbound, source bucket URL for fetching data
Processed Bucket If type is GCS Inbound, destination bucket URL to store processed data data
Field If type is GCS Inbound, field in the object to be used for the data

View the Integration Configuration

  1. Open Settings from the User menu.
  2. Select Integrations from the Automation dropdown menu.
  3. Select the Integration in the list that you want to view.
  4. Click the Integration name or ID to be taken to the detail view.

Delete an Integration

  1. Open Settings from the User menu.
  2. Select Integrations from the UX dropdown menu.
  3. Search for the Integration in the list that you want to delete.
  4. Click the Delete button. To see the Delete button, you must have Delete permission.

Thank you for following these steps to configure your SnapApp components effectively If you have any questions or need further assistance, please don’t hesitate to reach out to our support team. We’re here to help you make the most out of your SnapApp experience.

For support, email us at snapapp@bluevector.ai

Generate Text