Get a sample payload
curl --request GET \
--url https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload \
--header 'Authorization: Bearer <token>'import requests
url = "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"event_type": "entry_created",
"data": {
"form": "Wabc12",
"form_name": "Customer feedback",
"entry": {
"serial_number": 123,
"total_price": 123,
"preferential_price": 123,
"field_1": "Jack",
"field_2": "support@formhug.ai",
"x_field_1": "This is a passage",
"color_mark": "Green",
"creator_name": "Jim",
"created_at": "2026-05-12T10:48:13.909Z",
"updated_at": "2026-05-12T10:48:13.909Z",
"info_filling_duration": 123,
"info_platform": "Macintosh",
"info_os": "OS X 10.15.7",
"info_browser": "Chrome 147.0.0.0",
"info_remote_ip": "127.0.0.1",
"info_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
"reservation_status_fsf_field": "Booked"
}
}
}
}{
"error": "Form not found"
}{
"error": "Invalid trigger_event"
}Webhooks
Get a sample payload
Returns the payload shape that the webhook would deliver, useful for testing the receiver side.
Required scope: form:read.
GET
/
api
/
v1
/
forms
/
{form_token}
/
integrations
/
webhooks
/
sample_payload
Get a sample payload
curl --request GET \
--url https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload \
--header 'Authorization: Bearer <token>'import requests
url = "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://formhug.ai/api/v1/forms/{form_token}/integrations/webhooks/sample_payload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"event_type": "entry_created",
"data": {
"form": "Wabc12",
"form_name": "Customer feedback",
"entry": {
"serial_number": 123,
"total_price": 123,
"preferential_price": 123,
"field_1": "Jack",
"field_2": "support@formhug.ai",
"x_field_1": "This is a passage",
"color_mark": "Green",
"creator_name": "Jim",
"created_at": "2026-05-12T10:48:13.909Z",
"updated_at": "2026-05-12T10:48:13.909Z",
"info_filling_duration": 123,
"info_platform": "Macintosh",
"info_os": "OS X 10.15.7",
"info_browser": "Chrome 147.0.0.0",
"info_remote_ip": "127.0.0.1",
"info_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
"reservation_status_fsf_field": "Booked"
}
}
}
}{
"error": "Form not found"
}{
"error": "Invalid trigger_event"
}Authorizations
Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx.
The scope required by each endpoint is listed in that endpoint's description.
Path Parameters
Query Parameters
Target event_type; defaults to the first registered event when omitted
Available options:
entry_created, entry_updated, entry_paid Response
Success
Show child attributes
Show child attributes
Last modified on July 9, 2026
Was this page helpful?
⌘I