Webhook Payload

This section goes over the different types of webhook messages that you can receive. Currently, Connectly only supports WhatsApp messages.

Payload plain text:

JSON

{
  "timestamp": "1639083206",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "message": {
    "text": "TEST 11"
  }
}

Payload with referral

JSON

{
  "timestamp": "1639083206",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "message": {
    "text": "TEST 11",
    "referral": {
      "ctwaClid": "Click ID generated by Meta for ads that click to WhatsApp",
      "sourceUrl": "AD_OR_POST_FB_URL",
      "sourceId": "ADID",
      "sourceType": "ad or post",
      "headline": "AD_TITLE",
      "body": "AD_DESCRIPTION",
      "mediaType": "image or video",
      "imageUrl": "RAW_IMAGE_URL",
      "videoUrl": "RAW_VIDEO_URL",
      "thumbnailUrl": "RAW_THUMBNAIL_URL"
    }
  }
}

Payload media:

JSON

{
  "timestamp": "1639085537",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "message": {
    "attachments": [
      {
        "type": "video",
        "url": "https://cdn.dev.connectly.ai/asd/asdasdasdasd"
      }
    ]
  }
}

Payload button response

JSON

{
  "timestamp": "1639083206",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "context": {
    "replyToId": "018d62f2-2524-10fa-f857-091ab99c14c8"
  },
  "message": {
    "text": "TEST 11",
    "isButtonResponse": true
  }
}

Payload delivery status

JSON

{
  "topic": "delivery_status",
  "timestamp": "1641513098",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "statusUpdate": {
    "id": "01FRRWW2ZAHD9GJ1SWY4VF2GBD",
    "status": "delivered",
    "error": null
  },
  "metadata": {
    "campaign_name": "<YOUR_CAMPAIGN_NAME>"
  }
}

Payload delivery status error

JSON

{
  "topic": "delivery_status",
  "timestamp": "1641512856",
  "sender": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "connectlyai"
  },
  "recipient": {
    "id": "[phone]",
    "channelType": "whatsapp",
    "name": "Vasi from Connectly"
  },
  "statusUpdate": {
    "id": "01FRRWMSAMKNFZAMBPQ65CA7DD",
    "status": "delivery_failed",
    "error": {
      "message": "Message template inputs invalid",
      "type": "ERROR_TYPE_INVALID_REQUEST",
      "code": "ERROR_CODE_MESSAGE_TEMPLATE_INPUT_INVALID",
      "userTitle": "Message template inputs invalid",
      "userMessage": "Pass along the connectly trace id 'cnct_trace_id' to the team for more information.",
      "cntTraceId": "10827968052975079261",
      "details": {
        
      }
    },
    "metadata": {
      "campaign_name": "<YOUR_CAMPAIGN_NAME>"
    }
  }
}