Webmessaging: custom attributes should be provided inside the message

[Julien_Moreau]

Description

When the consumer application sends an inbound message, the custom attributes should be passed in:

message.channel.metadata. This is consistent with the structure of the response.

The former location, channel.metadata is deprecated now.

Example message with the new structure:

{
  "action": "onMessage",
  "token": "0000000-0000-0000-0000-0000000000",
  "message": {
    "type": "Text",
    "text": "This is the message with custom attributes"
    "channel": {
      "metadata": {
        "customAttributes": {
          "department": "sales",
          "property_type": "apartment",
          "device": "mobile"
        }
      }
    }
  }
}

Change Category

API

Change Context

Consistency of the API

Change Impact

Custom attributes attached to inbound messages should be provided in message.channel.metadata, and no longer in channel.metadata.

The legacy location will eventually be ignored, and so will be these custom attributes.

This is not a breaking change; existing requests using only channel.metadata will continue to work after this change without any code modifications by SDK consumers. There is no plan to remove the legacy property.

Date of Change

Immediate

Impacted APIs

webmessaging

References

[SHYRKA-1685]
[SHYRKA-1492]