⚙️Webhooks

Understand the structure of webhook payloads

Default payload structure

{
    "userWaNo": 919876543210,
    "formId": "1GlOz7Zt533nuMG0OL4BxwIsjzc37-JuslEzCZ9O9",
    "formName": "Registration Form",
    "version": 4,
    "inviteLink": "https://suprforms.link/*********",
    "createdAt": "2023-09-06T07:39:29.416Z",
    "updatedAt": "2023-09-06T07:39:39.760Z",
    "questions": [
    // Question 1
        {
            "id": "4f73a40d", // Original Question ID
            "originalQuestionText": "Name", // Original Question text
            "sfQuestionText": "What is your name?", // SuprForms Question Text
            "answer": [
                "John Doe" // User's reply
            ]
        },
    // Question 2
        {
            "id": "3d0d1f12",
            "originalQuestionText": "Interested in",
            "sfQuestionText": "What are the services you are interested in?",
            "answer": [
                "Surveys",
                "Feedback"
            ],
            "selectedOptionNos":[2,4] // Option nos of selected options
        }
    // And so on
    ]
}

You are supposed to always return with a 200 status.

Once you receive the webhook data, you can send a WhatsApp message back to the user by returning a JSON to the webhook call with the below structure. This is completely optional.

{
    "replyText": "Send this message back to user", // Message to be sent
}

Zapier payload structure

{
    "userWaNo": 919876543210,
    "formId": "1GlOz7Zt533nuMG0OL4BxwIsjzc37-JuslEzCZ9O9",
    "formName": "Registration Form",
    "version": 4,
    "inviteLink": "https://suprforms.link/*********",
    "createdAt": "2023-09-06T07:50:28.580Z",
    "updatedAt": "2023-09-06T07:51:18.907Z",
    // Q1 Data
    "originalQ1Text": "Name", // Original Form Question text
    "sfQ1Text": "What is your name?", // SuprForms Question text
    "a1Text": "John Doe", // User's reply to the question
    // Q2 Data
    "originalQ2Text": "Interested in",
    "sfQ2Text": "What are the services you are interested in?"
    "a2Text": "Surveys, Feedback"
    // and so on
}