webhooks
Webhook Payload Format
When a form submission is received, QuipForm sends a webhook request to your configured endpoint containing the submission data.
The payload is delivered as JSON and includes information about the form, submission, answers, and submission metadata.
This allows you to automate workflows, sync data with external systems, and build custom integrations.
Webhooks are sent as HTTP POST requests with a JSON payload whenever a new submission is received.
Payload Structure
A typical webhook payload contains four main sections:
- Form information
- Submission information
- Answers
- Metadata
Example:
{
"form_id": "form_123",
"form_title": "Customer Feedback Survey",
"submitted_at": "2026-01-01T12:00:00Z",
"answers": {
"Name": "John Doe",
"Email": "john@example.com",
"Rating": 5
},
"metadata": {
"country": "United States",
"browser": "Chrome",
"device": "Desktop"
}
}
Form Information
The payload includes details about the form that generated the submission.
Example:
{
"form_id": "form_123",
"form_title": "Lead Generation Form"
}
Available Fields
| Field | Description |
| ------------ | ------------------------------------ |
| form_id | Unique form identifier |
| form_title | Form title at the time of submission |
Submission Information
Submission details identify when the response was submitted.
Example:
{
"submitted_at": "2026-01-01T12:00:00Z"
}
Available Fields
| Field | Description |
| -------------- | --------------------------- |
| submitted_at | Submission timestamp in UTC |
Answers Object
The answers object contains all responses submitted by the respondent.
Example:
{
"answers": {
"Name": "John Doe",
"Email": "john@example.com",
"Company": "Acme Inc"
}
}
Field names correspond to the labels used in your form.
Depending on the field type, values may be:
- Text
- Numbers
- Boolean values
- Arrays
- Dates
- URLs
Example:
{
"answers": {
"Services": [
"Web Design",
"SEO"
]
}
}
Metadata Object
The metadata object contains information about the submission environment.
Example:
{
"metadata": {
"country": "United States",
"browser": "Chrome",
"device": "Desktop"
}
}
Common Metadata Fields
| Field | Description |
| ------------ | ---------------------------------------------- |
| country | Respondent country |
| browser | Browser used during submission |
| device | Desktop, Mobile, or Tablet |
| ip_address | Respondent IP address (if available) |
| referrer | Traffic source or referring URL (if available) |
Available metadata may vary depending on browser settings, privacy restrictions, and submission context.
HTTP Headers
Webhook requests are sent using standard HTTP headers.
Typical headers include:
Content-Type: application/json
Your endpoint should be configured to accept JSON payloads.
Testing Payloads
Before using webhooks in production:
- Configure a webhook endpoint.
- Submit a test response.
- Inspect the payload received.
- Verify your application processes the data correctly.
Testing helps ensure your integration behaves as expected.
Common Use Cases
Send Leads to a CRM
Forward submission data directly into sales workflows.
Create Support Tickets
Generate tickets automatically when forms are submitted.
Trigger Automations
Launch workflows in:
- Zapier
- Make
- n8n
- Pipedream
Store Data Internally
Sync submissions into custom applications and databases.
Example Endpoint
Example webhook destination:
https://yourdomain.com/api/webhooks/quipform
QuipForm will send the payload to this URL whenever a new submission is received.
Troubleshooting
Endpoint Isn't Receiving Data
Verify:
- The webhook URL is correct.
- The endpoint is publicly accessible.
- The server accepts POST requests.
Invalid JSON Errors
Ensure your application expects JSON and parses the request body correctly.
Missing Metadata
Some metadata may not be available depending on browser privacy settings and traffic sources.
Webhook Request Failed
Check:
- Server logs
- Response status codes
- Endpoint availability
QuipForm currently sends webhook events once when a submission occurs. Ensure your endpoint is available and ready to process incoming requests.
Related Articles
- Creating Webhooks
- Testing Webhooks
- Discord Webhooks
- Slack Webhooks
- Zapier Integration
Webhook payloads provide everything needed to automate workflows and process form submissions in real time.