How can we help?

Webhook Payload Structure: Migration Guide (v1 to v2)

We’ve upgraded our webhooks from v1 to v2. For most question types, there are no noticeable changes in the payload structure. For a few complex question types, the structure of the value field has been simplified to improve usability and integration.

Below are the v1 (old) and v2 (current) formats for the question types whose payload changed.

Address

v1

{
  "address": {
    "value": {
      "address": [
        { "label": "Street address", "content": "221B Baker Street" },
        { "label": "Street address line 2", "content": "Near Regent's Park" },
        { "label": "City", "content": "London" },
        { "label": "State/Province", "content": "Greater London" },
        { "label": "Postal/Zip Code", "content": "NW1 6XE" }
      ]
    },
    "field": "Current address",
    "type": "address"
  }
}

v2

{
  "address": {
    "value": {
      "Street address": "221B Baker Street",
      "Street address line 2": "Near Regent's Park",
      "City": "London",
      "State/Province": "Greater London",
      "Postal/Zip Code": "NW1 6XE"
    },
    "field": "Current address",
    "type": "address"
  }
}

Stripe Payments

v1

{
  "stripe_payment": {
    "value": {
      "stripe_payment": [
        { "label": "Amount", "content": "99.00 USD" },
        { "label": "Transaction ID", "content": "pi_3QxUfeHWmLk8AP3T020YcEia" }
      ]
    },
    "field": "Add payment details",
    "type": "stripe_payment"
  }
}

v2

{
  "stripe_payment": {
    "value": {
      "amount": "99.00 USD",
      "transaction_id": "pi_3QxUfeHWmLk8AP3T020YcEia"
    },
    "field": "Add payment details",
    "type": "stripe_payment"
  }
}

Razorpay Payments

v1

{
  "razorpay_payment": {
    "value": {
      "razorpay_payment": [
        { "label": "Amount", "content": "99.00 INR", "key": "amount_with_currency" },
        { "label": "Transaction ID", "content": "pay_SFcyUv0sLYiBbh", "key": "identifier" }
      ]
    },
    "field": "Add payment details",
    "type": "razorpay_payment"
  }
}

v2

{
  "razorpay_payment": {
    "value": {
      "amount": "99.00 INR",
      "transaction_id": "pay_SFcyUv0sLYiBbh"
    },
    "field": "Add payment details",
    "type": "razorpay_payment"
  }
}

Manual UPI Payments

v1

{
  "manual_upi_payment": {
    "value": {
      "manual_upi_payment": [
        { "label": "Amount", "content": "99.00 INR", "key": "amount_with_currency" },
        { "label": "UPI transaction ID", "content": "416171048092", "key": "identifier" }
      ]
    },
    "field": "Add payment details",
    "type": "manual_upi_payment"
  }
}

v2

{
  "manual_upi_payment": {
    "value": {
      "amount": "99.00 INR",
      "transaction_id": "416171048092"
    },
    "field": "Add payment details",
    "type": "manual_upi_payment"
  }
}

Matrix

v1

{
  "matrix": {
    "value": {
      "matrix_responses": [
        {
          "row_entity": {
            "id": "3265dee5-fa97-4d79-98d4-000afc4586f9",
            "label": "Ease of use",
            "position": 0,
            "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
            "created_at": "2025-07-18T14:15:28.482Z",
            "updated_at": "2025-07-18T14:15:28.482Z",
            "alt_id": "alt-fe2ve"
          },
          "value": [
            {
              "id": "30740087-c014-4c34-84d6-4dbbf33ad707",
              "label": "Very satisfied",
              "created_at": "2025-07-18T14:15:28.493Z",
              "updated_at": "2025-07-18T14:15:28.493Z",
              "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
              "position": 3,
              "alt_id": "alt-Wsiq4"
            }
          ]
        },
        {
          "row_entity": {
            "id": "ec2db83c-71a6-4e36-89ae-6bb5aa8f11b3",
            "label": "Performance",
            "position": 1,
            "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
            "created_at": "2025-07-18T14:15:28.485Z",
            "updated_at": "2025-07-18T14:15:28.485Z",
            "alt_id": "alt-NRUg9"
          },
          "value": [
            {
              "id": "ab2fe9d6-a7ef-46da-82e3-43763775830f",
              "label": "Satisfied",
              "created_at": "2025-07-18T14:15:28.495Z",
              "updated_at": "2025-07-18T14:15:28.495Z",
              "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
              "position": 2,
              "alt_id": "alt-5yxa19mdu57"
            }
          ]
        },
        {
          "row_entity": {
            "id": "d395f162-f83c-4b89-ad0b-d424f62e4ea2",
            "label": "Customer support",
            "position": 2,
            "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
            "created_at": "2025-07-18T14:15:28.487Z",
            "updated_at": "2025-07-18T14:15:28.487Z",
            "alt_id": "alt-e854tts5rs5"
          },
          "value": [
            {
              "id": "ab2fe9d6-a7ef-46da-82e3-43763775830f",
              "label": "Very satisfied",
              "created_at": "2025-07-18T14:15:28.495Z",
              "updated_at": "2025-07-18T14:15:28.495Z",
              "matrix_entity_id": "b2edf600-ffe4-44b1-81f9-cd966b5494db",
              "position": 3,
              "alt_id": "alt-5yxa19mdu57"
            }
          ]
        }
      ]
    },
    "field": "Product feedback",
    "type": "matrix"
  }
}

v2

{
  "matrix": {
    "value": {
      "Ease of use": ["Very satisfied"],
      "Performance": ["Satisfied"],
      "Customer support": ["Very satisfied"]
    },
    "field": "Product feedback",
    "type": "matrix"
  }
}

File Upload

v1

{
  "file_upload": {
    "value": {
      "files": [
        {
          "name": "invoice.csv",
          "url": "https://example.com/uploads/invoice.csv",
          "thumb_url": null,
          "signed_id": "signed_id_invoice_csv",
          "size": 327,
          "extension": "csv"
        },
        {
          "name": "welcome.pdf",
          "url": "https://example.com/uploads/welcome.pdf",
          "thumb_url": null,
          "signed_id": "signed_id_welcome_pdf",
          "size": 14925,
          "extension": "pdf"
        },
        {
          "name": "logo.jpg",
          "url": "https://example.com/uploads/logo.jpg",
          "thumb_url": "https://example.com/uploads/thumbs/logo.jpg",
          "signed_id": "signed_id_logo_jpg",
          "size": 14338,
          "extension": "jpg"
        }
      ]
    },
    "field": "File upload",
    "type": "file_upload"
  }
}

v2

{
  "file_upload": {
    "value": [
      { "name": "invoice.csv", "url": "https://example.com/uploads/invoice.csv", "size": 327 },
      { "name": "welcome.pdf", "url": "https://example.com/uploads/welcome.pdf", "size": 14925 },
      { "name": "logo.jpg", "url": "https://example.com/uploads/logo.jpg", "size": 14338 }
    ],
    "field": "File upload",
    "type": "file_upload"
  }
}

Product List

v1

{
  "product_list": {
    "value": {
      "total": "1000.00 USD",
      "currency": "usd",
      "products": [
        {
          "label": "T-Shirt",
          "description": "Cotton t-shirt",
          "quantity": 2,
          "options": { "Size": "M", "Color": "Blue" },
          "price": "500.00",
          "subtotal": "1000.00 USD",
          "image": null
        }
      ]
    },
    "field": "Our products",
    "type": "product_list"
  }
}

v2

{
  "product_list": {
    "value": {
      "total": "1000.00",
      "currency": "USD",
      "products": [
        {
          "label": "T-Shirt",
          "quantity": 2,
          "subtotal": "1000.00",
          "unit_price": "500.00",
          "options": { "Size": "M", "Color": "Blue" }
        }
      ]
    },
    "field": "Our products",
    "type": "product_list"
  }
}