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.

Fields

Field	Mandatory	Type	Description
Name	Yes	Text Box	Name given to the Subscription for ease of identification.
Record Type	Yes		Set to “Webhook”.
Webhook Version	Yes	Dropdown	Selects the version of Webhooks to send out. Please see Here for further details.
Webhook Batchsize	Yes*	Text Box	*For Version 2 Webhooks Only. Specify the maximum number of Events in a Webhook (Please see Here for further details).
Webhook Error Internal Profile	Yes	Dropdown	When a webhook reaches it's Retry Limit SmarterPay Cloud will email users attached to the Profile, or not if “– Do not send alerts –”, selected.
Webhook URL	Yes	Text Box	The URL of the endpoint for the webhook subscription. SmarterPay Webhooks are only available over HTTPS.

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.

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

"OAuth" or "OAuth + PKCE"

Fields

Field	Mandatory	Type	Description
Webhook Authorisation Type	Yes	Dropdown	Will be set to “OAuth” or “OAuth + PKCE”.
Grant Type	Yes	Text Box	Set to “Authorisation Code”. For applications on web servers, browser based and mobile.
Scope	Yes	Text Box	The scope values you have set up with your service. (Multiple values separated with spaces).
Authorisation Endpoint	Yes	Text Box	The authorisation endpoint provided by your service.
Token Endpoint	Yes	Text Box	The token endpoint provided by your service.
Client ID	Yes	Text Box	Your client ID from the setup of your application.
Client Secret	Yes	Text Box	Your client secret from the setup of your application. This will be kept confidential.
Webhook Signature Key	No	Text Box	Key used to encrypt the Webhook signature, if required.

"Signature"

Fields

Field	Mandatory	Type	Description
Webhook Authorisation Type	Yes	Dropdown	Will be set to “Signature”.
Webhook Signature Key	Yes	Text Box	Key used to encrypt the Webhook signature.

"Basic"

Fields

Field	Mandatory	Type	Description
Webhook Authorisation Type	Yes	Dropdown	Will be set to “Basic”.
Authentication Username	Yes	Text Box	Username used to log into webhook endpoint.
Authentication Password	Yes	Text Box	Password used to log into webhook endpoint.
Webhook Signature Key	No	Text Box	Key used to encrypt the Webhook signature, if required.

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 “payment” will only display events that contain payment

For every Event that is selected one, or more, Event Sources also needs to be selected.

Events available for selection are:

Event	Description	Notes
account_validation.create	Occurs when an Account Validation is created	Only sent for version 2 subscriptions
account_validation.update	Occurs when an Account Validation is updated	Only sent for version 2 subscriptions
bank_account.create	Occurs when a Bank Account is created
bank_account.update	Occurs when a Bank Account is updated
card_payment.create	Occurs when a Card Payment is created
card_payment.update	Occurs when a Card Payment is updated
credit.create	Occurs when a Credit is created
credit.update	Occurs when a Credit is updated
credit_request.failed	Occurs when a Bulk API Credit request fails	Only sent for version 2 subscriptions
customer_account.create	Occurs when a Customer Account is created
customer_account.update	Occurs when a Customer Account is updated
file_submission.create	Occurs when a File Submission is created
file_submission.update	Occurs when a File Submission is updated
input_report.create	Occurs when an input report record is inserted	Only sent for version 2 subscriptions
mandate.create	Occurs when a Mandate is created
mandate.update	Occurs when a Mandate is updated
payment.create	Occurs when a Payment is created
payment.update	Occurs when a Payment is updated
payment_link.create	Occurs when a Payment Link is created	Only sent for version 2 subscriptions
payment_link.update	Occurs when a Payment Link is updated	Only sent for version 2 subscriptions
payment_request.failed	Occurs when a Bulk API Payment request fails	Only sent for version 2 subscriptions
recurrence_schedule.create	Occurs when a Recurrence Schedule is created
recurrence_schedule.update	Occurs when a Recurrence Schedule is updated

Edit View

Subscription Setup

Fields

Actions

Security Setup

Fields

Fields

Fields

Events Setup