August 8, 2024

Updates

Added referral parameters to callback for incoming WhatsApp messages. This allows you to get API information about where the customer started a conversation in WhatsApp, if the customer started the conversation by switching to WhatsApp from a Facebook or Instagram ad. Learn more about the click-to-WhatsApp ads.

An example of a callback for an incoming WhatsApp message with referral parameters:

{
    "id": 115611,
    "subject": "test_WA",
    "subjectId": 195,
    "subscriber": {
        "id": 1111111,
        "identifier": "35000000000"
    },
    "userInfo": {
        "userName": "Anna",
        "firstName": null,
        "lastName": null,
        "avatarUrl": null
    },
    "messageContent": {
        "type": "TEXT",
        "attachment": null,
        "location": null,
        "referral": {
            "body": "This is a great product",
            "headline": "Our new product",
            "sourceId": "123",
            "sourceType": "ad",
            "sourceUrl": "https://www.fb.com"
        },
        "caption": null,
        "text": "text for test",
        "payload": null,
        "story": null,
        "items": null,
        "contact": null,
        "product": null,
        "catalog": null,
        "order": null
    },
    "receivedAt": "2024-01-11T11:20:00Z",
    "replyOutMessageId": null,
    "replyOutMessageExternalRequestId": null,
    "replyInMessageId": null
}


For a description of the nested parameters, see the article.

In this article
In this article