Edit View

Adding or Updating a Subscription record is split into two parts

  1. Defining the Subscription details, such as the endpoint and the Authentication used.
  2. 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.

A webhook subscription can be setup to use either “Signature Auth” or “Basic Auth” against the endpoint URL.
Here are examples of each of the Authentication types and the fields needed to setup a subscription for them.


"Signature Auth" Webhook Authentication type

Field Mandatory Type Description
Name Yes Text Box Name given to the Subscription for ease of identification.
Webhook Authentication Yes Dropdown Selects the type of authentication for the webhook endpoint.
Webhook Key Yes Text Box The “Signature Auth” key for the webhook endpoint.
Record Type Yes Set to “Webhook”.
Webhook Version Yes Dropdown Selects the version of Webhooks to send out. Please see Here for futher details.
Webhook Batchsize Yes* Text Box *For Version 2 Webhooks Only. Specify the maximum number of Events in a Webhook (Please see Here for futher details).
Webhook URL Yes Text Box The URL of the endpoint for the webhook subscription.


"Basic Auth" Webhook Authentication type

Field Mandatory Type Description
Name Yes Text Box Name given to the Subscription for ease of identification.
Webhook Authentication Yes Dropdown Selects the type of authentication for the webhook endpoint.
Authentication Username Yes Text Box The “Basic Auth” Username for the webhook endpoint.
Authentication Password Yes Test Box The “Basic Auth” Password for the webhook endpoint.
Record Type Yes Set to “Webhook”.
Webhook Version Yes Dropdown Selects the version of Webhooks to send out. Please see Here for futher details.
Webhook Batchsize Yes* Text Box *For Version 2 Webhooks Only. Specify the maximum number of Events in a Webhook (Please see Here for futher details).
Webhook URL Yes Text Box The URL of the endpoint for the webhook subscription.

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
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
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
mandate.create Occurs when a Mandate is created
mandate.update Occurs when a Mandate is updated
mandate.update.cancelled Occurs when a Mandate is cancelled
mandate.update.expired Occurs when a Mandate is expired
payment.create Occurs when a Payment is created
payment.update Occurs when a Payment is updated
recurrence_schedule.create Occurs when a Recurrence Schedule is created
recurrence_schedule.update Occurs when a Recurrence Schedule is updated
  • Last modified: 2023/01/26 12:21