Message Sent To Business

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a visitor, contact, or member sends a message to the business.

Permissions

Learn more about app permissions.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.

Event Data

idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.crm.inbox.v2.message.

slugstring

Event name. Expected message_sent_to_business.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON


{
  "data": {
    "eventType": "wix.crm.inbox.v2.message_message-sent-to-business",
    "instanceId": "<app-instance-id>",
    "data": "<stringified-JSON>",
    // The identity field is sent as a stringified JSON
    "identity": {
      "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
      "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
      "memberId": "<memberId>", // in case of MEMBER
      "wixUserId": "<wixUserId>", // in case of WIX_USER
      "appId": "<appId>" // in case of APP
    }
  }
}

Sample Data Shown:MessageSentToBusiness

JSON


{
  "id": "95c2f87d-ae78-4df9-aa21-95189231d6f7",
  "entityFqdn": "wix.crm.inbox.v2.message",
  "slug": "message_sent_to_business",
  "entityId": "1640771667091213",
  "actionEvent": {
    "body": {
      "conversationId": "5f65164f-b373-3cb9-be2e-f1fdc00c86a9",
      "message": {
        "targetChannels": [],
        "direction": "PARTICIPANT_TO_BUSINESS",
        "id": "1640771667091213",
        "sequence": "1640771667091213",
        "content": {
          "previewText": "JoJo Doe made an appointment",
          "form": {
            "title": "New Spa Appointment",
            "description": "JoJo Doe made an appointment",
            "fields": [
              {
                "name": "First Name",
                "value": "JoJo"
              },
              {
                "name": "Last Name",
                "value": "Doe"
              },
              {
                "name": "Treatments",
                "value": "Massage, Mud Bath, Facial"
              },
              {
                "name": "Appointment Date",
                "value": "May 9, 2021"
              }
            ],
            "media": [
              {
                "image": {
                  "url": "https://static.wixstatic.com/media/f93e3d633e79921f14330f1911fc1139.jpg/v1/fill/w_1200,h_798,al_c,q_85,usm_0.66_1.00_0.01/f93e3d633e79921f14330f1911fc1139.webp",
                  "width": 1200.0,
                  "height": 798.0
                }
              }
            ]
          }
        },
        "sender": {
          "contactId": "890a3816-85b4-44ab-9085-524972a850ef"
        },
        "appId": "a0c38670-6845-41e0-8f41-85a6054ccd98",
        "visibility": "BUSINESS",
        "sourceChannel": "UNKNOWN_CHANNEL_TYPE",
        "badges": [],
        "createdDate": "2021-12-29T09:54:27.091Z"
      }
    }
  },
  "eventTime": "2021-12-29T09:54:27.272823Z",
  "triggeredByAnonymizeRequest": false
}

Did this help?