Webhook Event for Message Created

Messages reside in Conversations. A Message is created when someone has posted a message in a conversation. A Message can have video, audio, and/or text content. A message may be sent by an identified person or sent anonymously.

Messages are created in any of these ways:

  • A user views a conversation then creates and posts a message in it.

  • A user submits a message via your intake page(s).

  • A text message can be created via Zapier.

  • A text message can be created via the API.

Here is an example request body:

{
  "type": "message_created",
  "id": "c6ec4301-8d97-4c53-8dff-06947ff750ca",
  "occurred_at": "2022-04-01T14:24:14.196+00:00",
  "payload": {
    "message": {
      "id": 330,
      "conversation_title": "April 1st, 2022 Conversation",
      "message_type": "text",
      "recorded_duration_seconds": null,
      "message_url": "http://awesomecompany.clarityflow.com/c/april-1st-2022-conversation1#message-330",
      "message_embed_url": "http://awesomecompany.clarityflow.com/embeds/messages/awesomecompany/330?conversation_slug=april-1st-2022-conversation1",
      "text": "<div class=\"trix-content\">\n  <div class=\"trix-content\">\n  <div class=\"trix-content\">\n  <div>asdf</div>\n</div>\n</div>\n</div>",
      "message_created_time": "2022-04-01 14:24:1648823053",
      "author": {
        "first_name": "User",
        "last_name": "Casel",
        "full_name": "User Casel",
        "email": "user@example.com"
      },
      "download_media_url": "https://zipmessage-production-input.s3.amazonaws.com/68u6m2jb5ydijz5oa4tk0ivm07hx?response-content-disposition=attachment%3B%20filename%3D%22recording.webm%22%3B%20filename%2A%3DUTF-8%27%27recording.webm&response-content-type=video%2Fwebm&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3ARUPDB3HFYUPVYV%2F20220701%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220701T201029Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=b8595e540eaf27dcd8c6e11c78d2e5bf9907e0e2932c6851f02a95e6aea9c4f0",
      "access_media_file": "https://zipmessage.com/330/download_media",
      "workflow": {}
    }
  }
}

Last updated