Summary
The use of channel.metadata for passing custom attributes in inbound Web Messaging messages is being deprecated.
Going forward, when a consumer application sends an inbound message, custom attributes must be provided in:
message.channel.metadata
This structure is consistent with the format used in API responses.
The legacy location:
channel.metadata is deprecated and will be ignored.
Effective Date
Friday, June 5, 2026
Details
This change improves API consistency by aligning the request payload structure with the response payload structure. Custom attributes will now be represented in the same location for both inbound messages and API responses.
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"
}
}
}
}
}
Customer Impact
Customers must update their integrations to provide custom attributes in:
message.channel.metadata
Custom attributes sent in the deprecated location:
channel.metadata
will be ignored and will no longer be processed.
To avoid disruption, customers should review and update any applications, integrations, or scripts that send inbound Web Messaging messages and migrate to the new structure before the deprecated field is removed.
Impacted Resources
webmessaging
Issue References
SHYRKA-3385
Contacts
@Julien Moreau Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.