Include Profile Addressability in Webhook Payloads

Configure your webhook payload to include profile addressability and subscription status.

When building a custom webhook payload, you can include standard profile attributes to understand whether a profile can be reached on a given channel and what their current subscription status is.

To use these fields, add them to your custom webhook schema using the {{ }} placeholder syntax. For more information on setting up a custom payload, see Custom Format in Webhooks integration.

Placeholder	Type	Description
`{{ email_addressable }}`	Boolean	Whether the profile is addressable by email. Returns `true` or `false`.
`{{ sms_addressable }}`	Boolean	Whether the profile is addressable by SMS. Returns `true` or `false`.
`{{ whatsapp_addressable }}`	Boolean	Whether the profile is addressable by WhatsApp. Returns `true` or `false`.
`{{ email_subscription }}`	String	The profile's email subscription status. Returns `"subscribed"`, `"unsubscribed"`, or `"undefined"`.
`{{ sms_subscription }}`	String	The profile's SMS subscription status. Returns `"subscribed"`, `"unsubscribed"`, or `"undefined"`.
`{{ whatsapp_subscription }}`	String	The profile's WhatsApp subscription status. Returns `"subscribed"`, `"unsubscribed"`, or `"undefined"`.

If you have a custom profile attribute with the same name as one of the standard attributes above, your custom attribute value will be used in the payload instead of the standard platform value.

Documentation Index

Include Profile Addressability in Webhook Payloads