Response structure

Configure your systems to consume webhook response by assigning appropriate fields based on your self-serve configurations.

Feature-set

Use this response structure if your feature enabled numbers are under process configurations -> Feature-sets. i.e This response structure is for customers which are on the new self-serve console.

Payload - Call Me Back

{
  "event_id": "91584c0f-32a8-11ef-a9e4-5a5798f0",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa163",
  "event_type": "cmb",
  "created_at": "1719288504",
  "cmb_payload": {
    "business_number": "0806951XXXX",
    "feature_set": "cmb",
    "client_number": "08047360",
    "requested_at": "1719288504",
    "requested_date": "26 June 2024",
    "requested_slot": "tomorrow"
  }
}

Payload - User Feedback

{
  "event_id": "d9f0c752-32a8-11ef-af53-3e643cc47",
  "client_account_id": "9b7f9343-12a5-4271-b560-6daa1638",
  "event_type": "user_feedback",
  "created_at": "1719288626",
  "survey_payload": {
    "business_number": "080698XXXXXX",
    "feature_set": "user_feedback_numbers",
    "client_number": "0804736XXXX",
    "requested_at": "1719288626",
    "user_responses": [
      {
        "question": "Did you find our services helpful?",
        "response": "Yes, very helpful!"
      }
    ]
  }
}

Number groups

Use this response structure if your feature configurations are tied to number groups. i.e This response structure is for customers which are on the old self-serve console.

Payload - Call Me Back

{
    "event_id": "15502265-74a2-4df7-a810-7b262d827",
    "client_account_id": "11f288fa-9e83-4aa5-968b-28df7ca53",
    "event_type": "cmb",
    "created_at": "1711709529734",
    "cmb_payload": {
        "business_number": "9190357XXXX",
        "number_group": "Capital City - sales",
        "client_number": "[phone]XXXX",
        "requested_at": "1711709529734",
        "requested_date": "30 Mar 2024",
        "requested_slot": "Saturday"
    }
}

Payload - User Feedback

{
  "event_id": "8140e293-c8e0-4102-bed4-5553c94f",
  "client_account_id": "11f288fa-9e83-4aa5-968b-28df7ca53",
  "event_type": "user_feedback",
  "created_at": "1711709820631",
  "survey_payload": {
    "name": "webhook_survey ",
    "business_number": "[phone]XXXX",
    "number_group": "Capital City - Support numbers",
    "client_number": "+9190190XXXXX",
    "user_responses": [
      {
        "question": "Did you find our support response helpful?",
        "response": "Yes, somewhat helpful."
      }
    ]
  }
}