Payload Media Types

Webhook Payload Media Types

Connectly webhooks support 4 media types that correspond to certain MIME types:

Type	Description	Supported MIME types
image	images in .jpeg, .png format	- image/jpeg - image/png
video (Coming soon!)	video files	- video/mp4 - video/3gpp
audio	audio files and audio recordings	- audio/aac - audio/mp4 - audio/mpeg - audio/amr - audio/ogg - audio/ogg; codecs=opus
document	work documents, text files and all other file types that are not listed in the previous 3 categories	Most common MIMEs: - text/plain - application/pdf - application/vnd.ms-powerpoint - application/msword - application/vnd.ms-excel - application/vnd.openxmlformats-officedocument.wordprocessingml.document - application/vnd.openxmlformats-officedocument.presentationml.presentation - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/vnd.android.package-archive

The media webhook payload has the following format:

JSON

{
  "timestamp": "1640204070",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "message": {
    "attachments": [
      {
        "type": "audio",
        "url": "https://cdn.connectly.ai/46b6/46b6725c-a821-480c-901b-8a76b990a25c"
      }
    ]
  }
}

The media payload is stored under attachments. Connectly supports sending multiple attachments in one webhook event but currently, only ONE attachment is sent at a time. The type indicates the media type and the media file is accessible by visiting the url. If you download the media file from the URL programmatically then you should get the MIME type from the response headers.