Webhook
Send each Encatch survey response as JSON to your own HTTPS endpoint - payload reference, signing secret and retries
Beta. The Webhook connector is new. The payload below is version 1 and stays as it is: a later change will come as a new connector version, and yours keeps working.
Overview
The Webhook connector sends each survey response as one HTTPS POST with JSON to an endpoint you run. The same payload goes to Zapier, n8n, Make and Power Automate; this page is its reference.
| What it gets | Each response as one JSON call |
| Events | Survey submitted, and Survey partially submitted when ticked |
| Anonymous respondents | Supported, with Include anonymous respondents on |
| Status | Beta |
Looking for a message you write yourself, with a template and filters, for one form? That is the Webhooks destination. This connector sends a fixed, structured payload for all surveys or the ones you pick, with retries, a rate limit and delivery logs.
What You'll Need
Before you start, make sure you have:
- A public HTTPS endpoint on port 443 — reachable from the internet. Encatch never calls IP addresses, internal names or other ports
- An endpoint that answers quickly — any 2xx status means received. If the work is slow, process the call after answering
Step 1: Add the connection in Encatch
- In Encatch, open Data sync → Survey events and click Add connection.
- Choose Webhook and enter a Name.
- Fill in the settings:
| Field | What to enter |
|---|---|
| Webhook URL | Your endpoint's address, starting with https://. A path and query string are allowed. |
| Signing secret | Optional. With it, Encatch signs each call so your endpoint can check it came from Encatch. See below. |
- Pick the surveys. Tick Survey partially submitted if you also want responses left unfinished.
- Press Test connection and check that your endpoint received a call with
"test": true. - Click Save, then press Start sending.
Encatch keeps the URL and the secret encrypted and shows only the URL's host afterwards. The form has Copy sample payload, with the answer keys as your Answer keys option makes them.
The payload (version 1)
{
"version": 1,
"event": "Survey submitted",
"event_id": "7f1c2a9e-…",
"occurred_at": "2026-11-08T10:15:00.000Z",
"test": false,
"user": { "id": "user-123", "anonymous": false, "anonymous_id": null },
"form": { "id": "9b2d6c1e-…", "name": "NPS survey", "slug": "nps-survey" },
"response": {
"id": "3e8a4f7b-…",
"status": "submitted",
"answers": { "nps_score": 9, "reason": "Fast support", "features": ["Reports", "Data sync"] },
"questions": [
{ "key": "nps_score", "question_id": "…", "title": "How likely are you to recommend us?", "type": "nps", "value": 9 }
]
}
}| Field | Meaning |
|---|---|
version | Payload version. |
event_id | Unique per response and connection. A retry sends the same event_id: use it to skip a repeat. |
occurred_at | When the response was submitted or closed. |
test | true for Test connection calls. |
user.id | The user's identifier in Encatch; null for an anonymous respondent. User traits are not sent. |
user.anonymous | true for an anonymous respondent, false for an identified user. Filter or branch on it. |
user.anonymous_id | Only with Include anonymous respondents on: the device ID the SDK gave a respondent who is not signed in. null for identified users. |
form | The form's ID, name and slug. |
event, response.status | Survey submitted with submitted, or Survey partially submitted with partial and the answers given so far. |
response.answers | One field per question, keyed by the connection's Answer keys option: the question's slug (default), its ID or its title. |
response.questions | The same answers with each question's ID, title and type. |
A response is sent as partial or as submitted, never both. On a form that lets people edit their response, each edit they submit comes again as submitted under the same response ID, with a new event ID.
Signing secret
With a signing secret, each call carries two headers:
X-Encatch-Timestamp: the time of the call, in Unix seconds.X-Encatch-Signature:sha256=followed by the hex HMAC-SHA256 of<timestamp>.<raw body>, keyed with the secret.
Recompute the signature over the raw body, compare in constant time, and refuse timestamps older than 5 minutes.
import { createHmac, timingSafeEqual } from 'node:crypto'
function fromEncatch(rawBody, timestamp, signature, secret) {
const expected = 'sha256=' + createHmac('sha256', secret).update(`${timestamp}.${rawBody}`).digest('hex')
const fresh = Math.abs(Date.now() / 1000 - Number(timestamp)) < 300
return fresh && expected.length === signature.length && timingSafeEqual(Buffer.from(expected), Buffer.from(signature))
}Retries
| Your answer | What Encatch does |
|---|---|
| 2xx | Sent. |
| 429, 5xx, or no answer within the timeout | Tries again after 1 minute, 10 minutes, then 1 hour. |
| Any other 4xx | Stops for that response. Logs show your status and the start of your answer. |
Good to know
- Size. Calls are at most 1 MB.
- Only new responses. Only responses submitted after the connection was started are sent.
- Repeats. A retry can deliver a response twice: use
event_idto skip a repeat. - Every option of the form is explained in Connection settings.
Was this page helpful?
