POST
/webhooksCreate Webhook
Create a new webhook endpoint to receive event notifications
Scope: WEBHOOKS_WRITE
Overview
Creates a new webhook endpoint. The URL must be a unique HTTPS endpoint. A signing secret is automatically generated for HMAC-SHA256 payload verification.
Request
POST
/webhooksHeaders
| Header | Value |
|---|---|
Authorization | Bearer fxk_live_<your-api-key> |
Content-Type | application/json |
Request Body
Example Request
curl -X POST "https://api.formfex.com/api/v1/public/webhooks" \
-H "Authorization: Bearer $FORMFEX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/webhooks/formfex",
"events": ["FORM_RESPONSE_CREATED", "FORM_PUBLISHED"],
"description": "Production webhook"
}'Response
Response Fields
| Field | Type | Description |
|---|---|---|
data.id | string | Unique webhook endpoint identifier (UUID) |
data.url | string | HTTPS URL that receives webhook events |
data.events | string[] | Array of subscribed event types |
data.secretLast4 | string | Last 4 characters of the generated signing secret |
data.isActive | boolean | Always true on creation |
data.description | string | null | Optional description |
data.createdAt | string | ISO 8601 creation timestamp |
data.updatedAt | string | ISO 8601 last update timestamp |
Error Cases
| Status | Cause |
|---|---|
409 | A webhook endpoint with this URL already exists for this account |
Notes
Save your signing secret
The full signing secret is only available through the Formfex dashboard when the endpoint is first created. Store it securely — you'll need it to verify webhook signatures.
Plan Requirement
Webhooks require a Starter plan or higher.