Trusted sites
    • 2 Minutes to read

      Trusted sites


        Article summary

        There are five authentication method types for third-party communications supported by Antavo: Base64 encoding, Amazon Web Services (AWS), AWS-Simple Storage Service (S3), JSON Web Token (JWT) and OAuth. The Trusted sites module offers an interface to configure and manage multiple webhook authentication methods on one single page.

        After configuring the sites on this interface, you will be able to select them from a dropdown menu when implementing a workflow using the Webhook message action node. This option eliminates the need to type each system detail in all Webhook message nodes where that system is targeted.

        To access the configuration page, navigate to the Modules menu and search for the Trusted sites module. The page will open to the list of sites that are already added, displaying the following information:

        • Name

        • Authentication method

        • URL

        • Content type

        Adding a new site

        To add a new authentication, click Add new site in the left sidebar.

        • Name (required)
          Enter the name for the trusted site. This name will appear and be selectable in the dropdown of the Webhook message workflow node.

        • URL (required)
          Add the URL address of the trusted website.

        • Content type
          Specify the media type of the resource, e.g.: application/json

        • Authentication method
          Choose from five authentication method types, each with specific configuration fields:

          • Basic: Adds a webhook header with basic authentication fields encoded in Base64.

            • Username

            • Password

          • AWS: Adds a complete AWS signature.

            • Region

            • Service

            • Access key ID

            • Access key secret

            • Algorithm prefix (optional)

            • Vendor key (optional)

          • AWS-S3: Adds a complete AWS signature compatible with Amazon Web Services S3 Bucket communications.

            • Service

            • Access key ID

            • Access key secret

            • Filename format

          • JWT: Transmits information as a JSON object.

            • Algorithm
              Select the encryption method: RSA Signature with SHA-256 (RS256) or HMAC with SHA256 (HS256)

            • Secret
              The token is signed using this key, click the eye button to show it or hide it.

            • Payload
              Add key-value pairs, the key is always a string and the value can be any JSON value.

            • Time-to-live
              Expiration time in ({number} minute(s)|hour(s)|day(s)|month(s)|year(s)) format

          • OAuth2: Validates an access token by communicating with the OAuth server.

            • Consumer key

            • Consumer secret

            • Authorization URL

            • Scope (optional)

            • Response type (optional)

            • Token URL

        After saving the new site, the Redirect URL will be displayed on the page, constructed by the website ID and the callback endpoint.

        The Redirect URL appears after adding facebook.com as an OAuth-type trusted site

        If no access token has been acquired automatically, a Connect button will appear in the upper right corner. Clicking this button will redirect you to the configured Authorization URL.

        If the acquired access token expires, the Connect button will reappear, allowing you to start the process again and acquire a new token. If Antavo has received a Refresh token after exchange, it will also be saved at trusted_sites.auth_params.refresh_token.

        In the case where we have a Refresh token and the Access token expires, the action button Refresh access token will be displayed. Clicking the refresh button will send a POST request to the Token URL to exchange the Refresh token for a new Access token and a new Refresh token.

        Activating a trusted site

        After saving for the first time, the status of the added authentication is set to draft. This means it appears only in the list of trusted sites on the module configuration page and won’t appear among the options in the Webhook message workflow node’s dropdown.

        You can activate it right away using the Set active button on the upper right-hand side of the setup page and confirm the activation in the subsequent dialog. Also, you can deactivate it anytime by clicking Set inactive.