Full Bodied Webhooks

By default, webhook notifications include only key event details, which can be used to retrieve full message information from Messages Services. However, users have the option to include the entire message body for more comprehensive processing. This setting is configurable, allowing flexibility based on specific requirements. When enabled, the webhook notification includes an additional field, messageBase64, which contains the full message encoded in Base64 for efficient transmission and processing.

{
    "eventId": "8e0f3c1a-9b5d-4e7e-8f6c-2f1e2d3a4b5c",
    "eventTimestamp": "2024-03-16T05:01:02.171+00:00",
    "subscriptionReference":"232af6ba-6758-475b-ae2d-a957f470c298",
    "messageResponseId": "RESad6d57e211a94f1591b72fba9d63092b",
    "messageRequestId": "REQdc1be8be0f274bcda6c3e027b44cdd8c",
    "messageType": "ACCOUNT_STATEMENT",
    "messageCreatedTime": "2024-03-16T05:01:02.171+00:00",
    "regCode": "110022",
    "regCodeIssuer": "GB",
    "bankCode": "LHVUK",
    "messageBase64": "PHh...sxbV9jb250ZW50Lz4="   // Base64 encoded data here
}

Enabling/ Disabling Full Bodied Webhooks

The attachFullBody field allows users to enable or disable the inclusion of the full message body in he webhook. By setting this flag to true, the full message will be attached to the webhook payload encoded in base64, providing full information for efficient message handling.

This field can be configured during the creation of a webhook configuration or updated later through the edit configuration endpoint, offering flexibility to adjust the webhook content as requirements evolve. See Managing Webhook Configurations