Webhooks Events

Message Created

This event is triggered when a conversation has a new message.

The event payload contains the event type, the content of the message created, and additional information about the conversation.

postWebhookmessageCreated

Payload

type'message_created'

Example payload

{
  "payload": {
    "message": {
      "date": "2023-01-31 16:22:17.327878+00:00",
      "sender_label": "Jane Doe"
    },
    "conversation": {
      "consumer_img": "https://www.example.com/profile-picture.jpg",
      "consumer_name": "John Doe",
      "consumer_phone_number": "+33612345678",
      "consumer_email": "john.doe@example.com",
      "last_message": {
        "date": "2023-01-31 16:22:17.327878+00:00",
        "sender_label": "Jane Doe"
      },
      "created_at": "2023-01-31 16:22:17.327878+00:00",
      "messaging_partner": "Facebook",
      "issues": [
        "facebook_no_page_linked"
      ],
      "last_message_date": "2023-01-31 16:22:17.327878+00:00",
      "assigned_user_id": "62d80fae74e8b11d700302b8"
    }
  }
}

Response

Return a 200 status to indicate that the event was properly received

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.