Configure Channel Providers

The FtosProvider uses SendGrid in order to send emails. SendGrid is a cloud-based platform that solves the challenge of email delivery. SendGrid provides and manages an email server on your company's behalf, so your communications with customers are reliably sent and delivered as needed.

1 Apply for subscription key

Go to the FintechOS Services Portal and apply for a subscription key for the FintechOS Omnichannel Communication Automation processor. You need the subscription key to configure the automation processor, which is editing the FTOSEmailGateway channel provider so that it uses this processor.

2 Edit the FTOSEmailGateway channel provider

To configure the Automation Blocks you need to edit the FTOSEmailGateway channel provider:

  1. Log into the FintechOS Studio. From the menu, click Admin > Omnichannel Communication Automation > Channel Providers.
  2. Double click the 'FTOSEmailGateway' record.

  3. Fill in the following mandatory fields:

    FieldData typeDescription
    Communication ChannelOption setSelect email from the option set. For details, see View Channel Configurations.
    Name TextThe FTOSEmailGateway name is filled in.
    Provider Name TextInsert the name of the provider.
    Service UrlTextThe URL provided by FintechOS
    App user TextIt is the user credentials given by the provider.
    App PasswordTextIt is the password given by the provider.
    App KeyTextThe subscription key provided by the FintechOS Services Portal for the FintechOS Omnichannel Communication Automation processor.
    appConfigTextThe configuration file.
    From AddressText

    The email address from which the emails will be sent to customers. It is the email address displayed in the From field of the email sent to customers.

    IMPORTANT!  
    Please, be sure to consult FintechOS to create an email address with the name of the company.
    From Display NameTextThe name that appears next to the sender's email address in the recipient's inbox.
    Bulk NoWhole NumberThe number of emails that are processed in one step.
    Days Before ExpireWhole NumberHow many days are left before the email expires.
    Interval Min TextIt is the limit for sending messages. The job will send messages only in this time frame (HH:MM:SS) (UTC time).
    Interval MaxTextIt is the limit for sending messages. The job will send messages only in this time frame (HH:MM:SS) (UTC time).
    Retry Max AttemptWhole numberThe maximum number of times the server tries sending the message if the message status is 'Error'.
    Pool Time RetryTextThe time interval the server waits until it attempts to send the message that has previously failed (message status is 'Error'). The format is HH:MM:SS (hours:minutes:seconds).
    Open SettingBoolTracks the open email events.
    Click SettingBoolTracks the clicked links within the email body events.
  4. At the top-right corner of the page, click the Save and reload icon to save the changes.
  5. The Channel Provider Statuses section displays the list of channel provider statuses. Failed requests return an error that contains: a response code, a message explaining the reason for the error and a link to any relevant documentation that might help you troubleshoot the problem.

    Double-click a status to edit it.

    The list of statuses and their codes is below. Please keep in mind that each email provider might have other codes, therefore if you're using an email provider different than SendGrid, the below list might not apply.

    Error CodeError reasonDescription
    200OKYour message is valid, but it is not queued to be delivered.
    202ACCEPTEDYour message is both valid, and queued to be delivered.
    400BAD REQUEST 
    401UNAUTHORIZEDYou do not have authorization to make the request.
    403FORBIDDEN 
    404NOT FOUNDThe resource you tried to locate could not be found or does not exist.
    405METHOD NOT ALLOWED 
    413PAYLOAD TOO LARGEThe JSON payload you have included in your request is too large.
    415UNSUPPORTED MEDIA TYPE 
    429TOO MANY REQUESTSThe number of requests you have made exceeds the rate limitations.
    500SERVER UNAVAILABLEAn error occurred on the server.
    503SERVICE NOT AVAILABLEThe Email Gateway v3 Web API is not available.
    bounceERRORThe receiving server could not accept the message.
    deliveredOKThe email was sent successfully delivered to the recipient.
    droppedERRORathe email will not be sent.