Edit View

Adding or Updating a Subscription record is split into three parts

Defining the Subscription details, such as the endpoint.
Defining the Security Setup, such as the authentication used.
Selecting the events that the subscription should listen to.

Actions

Available actions, subject to permissions, are:

Action	Description
“SAVE CHANGES” Button	Save changes and return to the Detail view page.
“CANCEL” Button	Cancel any changes and return to the Detail view page.

Fields

Field	Mandatory	Type	Description
Name	Yes	Text Box	Name given to the Subscription for ease of identification.
SMTP Host	Yes*	Text Box	Email server host name or IP address.
SMTP From Address	Yes*	Text Box	Email address used as for the from/reply address.
SMTP Rate Limit	Yes*	Text Box	Number of emails allowed per hour for this subscription. Emails will be delayed an hour after reaching this limit.
Company Details Branding	N/A*	Dropdown	By default SmarterPay branding will be used for emails sent using the subscription. Custom details can be sent by setting up Ecommerce Branding and then selected here.

* If “Authorisation Type” is set to “SmarterPay” these fields are not displayed/required.

The fields needed for security is determined by the option selected for “Authorisation Type”. Please click on the options for more details.

"Basic"

Field	Mandatory	Type	Description
SMTP Username	Yes	Text Box	Username needed to log in to the Email server.
Authorisation Type	Yes	Dropdown	Will be set to “Basic”.
SMTP Password	Yes	Text Box	Password needed to log into the Email server.

"Microsoft"

Field	Mandatory	Type	Description
SMTP Username	Yes	Text Box	Username needed to log in to the Email server.
Authorisation Type	Yes	Dropdown	Will be set to “Microsoft”.
Tenant ID	Yes	Text Box	The Microsoft directory tenant that Cloud will operate against, in GUID or domain-name format.
Grant Type	Yes	Dropdown	Must be set to Client Credentials.
Client ID	Yes	Text Box	The application ID that's assigned to your app.
Client Secret	Yes	Text Box	The client secret that you generated for your app in the app registration portal.
Oauth Scopes	No	Text Box	(Required) The resource identifier (application ID URI) of the resource you want, suffixed with “.default”.
Token URL	Yes	Text Box	Token will be initially populated, and then modified using the entered Tenant ID value.

For more information regarding these settings please see Microsoft's website: https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth

"OAuth"

Field	Mandatory	Type	Description
SMTP Username	Yes	Text Box	Username needed to log in to the Email server.
Authorisation Type	Yes	Dropdown	Will be set to “OAuth”.
Tenant ID	Yes	Text Box	Tenant ID of the application.
Grant Type	Yes	Dropdown	Options available: “Client Credentials”.
Client ID	Yes	Text Box	Client ID of the application.
Client Secret	Yes	Text Box	Client secret of the application.
Oauth Scopes	No	Text Box	Scope of the application.
Token URL	Yes	Text Box	Token URL of the application.

"SmarterPay"

By default all Events, selected or not, are shown in the edit view. This list can be filtered by entering text into the “Search” box, at the top of the events list.

For example, entering “mandate” will only display events that contain mandate

For every Event that is selected, where the email is sent, and the template it uses needs to be set.

The first selection is where to send the email, Internal and/or External.

Internal uses the Profile selected.
External uses the email address set on the Customer record associated with the trigger.

The second selection is which profile to use for Internal emails.

The third selection is which Email Template to use for the emails.

Events available for selection are:

Event	Description	Notes
account_validation.create	Occurs when an account validation has been created
bank_account_check_bulk.update.completed	Occurs when a Bank Account Check Bulk is completed
bank_account_check_bulk.update.failed	Occurs when a Bank Account Check Bulk has failed
file_submission.create	Occurs when a file submission is created
file_submission.update.error	Occurs when a file submission has errors
file_submission.update.submitted	Occurs when a file submission is submitted
file_submission.update.submitted.warnings	Occurs when a file submission is submitted with warnings
file_submission.update.submitted_with_errors	Occurs when a file submission is submitted with errors
file_upload.update.approved	Occurs when a File Upload has been approved
file_upload.update.approved.warnings	Occurs when a File Upload has been approved with warnings
file_upload.update.error	Occurs when a File Upload is has errored
file_upload.update.submitted	Occurs when a File Upload has been submitted
file_upload.update.submitted.warnings	Occurs when a File Upload has been submitted with warnings
file_upload.update.uploaded	Occurs when a File Upload is completed
file_upload.update.uploaded.warnings	Occurs when a File Upload is completed with warnings
mandate.create.new_instruction	Occurs when a mandate is inserted as new instruction
mandate.create.on_hold	Occurs when a mandate is inserted as on hold
mandate.update.cancelled_by_originator	Occurs when a mandate is cancelled
mandate.update.new_instruction	Occurs when a mandate is updated to new instruction
mandate.update.on_hold	Occurs when a mandate is updated to on hold
payment.create.card_payment.failed	Occurs when a card payment is inserted
payment.create.card_payment.refund	Occurs when a card payment has been refunded
payment.create.card_payment.successful	Occurs when a card payment is inserted
payment.create.direct_debit	Occurs when a payment is created
payment.update.card_payment.failed	Occurs when a card payment has failed
payment.update.card_payment.successful	Occurs when a card payment has been successful
payment.update.direct_debit.failed	Occurs when a payment is updated to failed
payment.update.direct_debit.successful	Occurs when a payment is updated to successful
payment_link.create	Occurs when a payment link has been created
recurrence_schedule.create.card_payment	Occurs when a Card recurrence schedule has been created
recurrence_schedule.create.directdebit	Occurs when a Direct Debit recurrence schedule has been created
recurrence_schedule.update.card_payment.cancelled	Occurs when a Card recurrence schedule has been cancelled
recurrence_schedule.update.directdebit.cancelled	Occurs when a Direct Debit recurrence schedule has been cancelled
recurrence_schedule.update.card_payment.schedule_update	Occurs when a Card recurrence schedule upcoming payments has been updated, this will only trigger from Portal and API actions
recurrence_schedule.update.directdebit.schedule_update	Occurs when a Direct Debit recurrence schedule upcoming payments has been updated, this will only trigger from Portal and API actions

Edit View

Subscription Setup

Actions

Fields

Security Setup

Events Setup