Skip to main content

eDD Webhooks

eDD now supports enhanced webhook functionality.

G
Written by Gemma Langley
Updated over a week ago

Webhooks are now supported for Electronic Direct Debit (eDD), allowing your systems to receive real‑time notifications when a customer completes an eDD sign‑up. Each webhook sends a secure HTTPS POST containing the sign‑up details in JSON format, enabling automated workflows without manual intervention.


Enabling Webhooks

Webhook functionality is not enabled by default. To have it switched on for your organisation, please contact our Access Digital Assistant and request to speak with a support agent. Once Support has enabled the feature, the webhook configuration options will appear in your Access Payments site settings.

Once Support has enabled webhook functionality, a Webhook Configuration step will appear when creating a new site in the Site Configuration Wizard.

In this step, you will enter:

  • Webhook URL – your HTTPS endpoint for receiving eDD webhook notifications (must support TLS 1.2 or higher).

  • Shared Secret – used to verify that webhook requests sent to your system are authentic.

The system automatically checks the URL as you enter it. If the URL is invalid, such as not using HTTPS, you’ll be prompted to correct it.

Once the required details are entered and saved, a Test Connection button becomes available to verify the webhook connection.


Managing Webhooks

Once your site has been set up with webhooks, an additional option will appear in the site’s Actions dropdown menu titled Manage Webhooks.

Selecting this option opens a panel displaying:

  • The current webhook status

  • The webhook URL

  • The last successful delivery

If the webhook is shown as Suspended, you’ll also see a Re‑enable button, which you can use after resolving the issue that caused the failures.


Webhook Triggers

When a customer completes an eDD sign‑up on your site, the system sends an HTTPS POST request to your webhook URL with the sign‑up details in JSON format. If the delivery fails, it is automatically retried up to three times before the webhook is suspended.


Webhook Payload Information

When a webhook is triggered, your endpoint receives a JSON payload containing key details about the eDD transaction, including:

  • DDI_Reference

  • BacsReference

  • Reference

  • PayerReference

  • FrequencyOfCollection

  • FrequencyType

  • StartDate

  • FirstAmount

  • RegularAmount

  • GiftAid

  • AccountName

  • FirstName

  • LastName

  • AddressLine1

  • Town

  • Postcode

  • EmailAddress

  • DDICreated


Email Notifications

You will receive an email if a webhook is suspended after repeated failures.

Subject: URGENT: Webhook Suspended – [Site Name]

The email includes:

  • Site name

  • Webhook domain

  • Suspension time

  • Last three failure reasons

  • Instructions to re-enable


Status Indicators

The site list includes a Webhooks column showing:

  • Green Circle: Webhooks are enabled and working normally

  • White Circle: Webhooks are not configured

  • Grey Circle: Webhooks are disabled

  • Red Circle: Webhook deliveries have failed and need attention

Hovering over the icon displays additional information.

Did this answer your question?