Knowledge Base

Formulayt supports sending form submission data to external services via webhooks. Although our primary example is Zapier, the webhook system itself is open-ended and can be integrated with any endpoint that can receive and process JSON over HTTP. This guide will walk you through the steps to activate webhook integration on your account, create and manage webhook subscriptions, and handle form submission data in your own code or third-party service.

1. Activate the Webhook Integration and Retrieve Your Credentials

Before your Formulayt forms can send data to your custom endpoint, you must:

1. Activate the Zapier/Webhook integration in your Formulayt account.
   1. This is done in the Apps section of your Formulayt dashboard.
   2. As soon as the integration is active, and you set your account or inidividual form type(s) to start submitting to it, Formulayt will attempt to send form submission data through any valid webhooks you have registered.
2. Obtain your Formulayt account ID and the secret API key.
   1. Your account ID uniquely identifies your Formulayt account.
   2. The secret API key is used to authenticate requests to Formulayt’s subscription management endpoints (it must be kept private).
   3. If you suspect your API key has been exposed, please revoke it in Formulayt and generate a new one to maintain security.

Important: Once the webhook integration is active and being used by one or more form types form submission, if you do not register any valid subscriptions, form submissions will result in an error (NO_VALID_WEBHOOKS), and your users will be unable to submit forms.

2. Build Your Endpoint to Accept Incoming Form Submissions

Next, you need to implement a listener (endpoint) on your server or application to handle the HTTP POST requests that Formulayt will send. This endpoint can be written in any language or framework as long as it can:

    •    Accept HTTP POST requests.

    •    Parse incoming JSON data.

    •    Respond with an appropriate HTTP status code (usually 2xx on success or 4xx/5xx on errors).

2.1 Understanding the Payload

When a user submits a form, Formulayt will POST a JSON payload to your configured target_url. The exact structure is account-specific (since every Formulayt account may have different default fields), but it is generally a flat JSON object containing:

    •    One or more form fields from the submitted form (keys match your configured field names in Formulayt).

    •    A serverTimestamp field indicating the time at which the submission was processed on Formulayt’s servers.

Below is a generic example of what a form submission payload might look like. Actual field names will depend on the form fields you configure in Formulayt:

{
  "firstName": "John",
  "lastName": "Smith",
  "email": "john.smith@test.com",
  "company": "Test Company",
  "country": "GB",
  "phone": "+441234567890",
  "jobTitle": "Manager",
  "serverTimestamp": "2024-02-01T12:34:56.789Z"
}

POST /my-webhook-endpoint

function handleFormulaytWebhook(request):
    // Parse the JSON body
    data = parseJSON(request.body)

    // Log or handle the data
    log("Received form submission from Formulayt:", data)

    // Return a success response
    return HTTP 200 OK

POST https://app.gatedcontent.com/api/v1/subscriptions

Example Request (cURL):

curl -X POST "https://app.gatedcontent.com/api/v1/subscriptions" \
     -H "Content-Type: application/json" \
     -d '{
       "account_id": "YOUR_ACCOUNT_ID",
       "api_key": "YOUR_API_KEY",
       "event": "form.submission",
       "target_url": "https://myapi.example.com/formulayt-webhook"
     }'

{
    "Error": false,
    "Message": "SUCCESS",
    "Body": 1
}

GET https://app.gatedcontent.com/api/v1/subscriptions/sample

{
    "Error": false,
    "Message": "SUCCESS",
    "Body": {
       "firstName": "John",
       "lastName": "Smith",
       "email": "john.smith@test.com",
       "company": "Test Company",
       "country": "GB",
       "phone": "+441234567890",
       "jobTitle": "Manager",
       "serverTimestamp": "2025-02-06T13:45:12.345Z"
     }
}

DELETE https://app.gatedcontent.com/api/v1/subscriptions/:id

curl -X DELETE "https://app.gatedcontent.com/api/v1/subscriptions/SUBSCRIPTION_ID" \
     -H "Content-Type: application/json" \
     -d '{
       "account_id": "YOUR_ACCOUNT_ID",
       "api_key": "YOUR_API_KEY"
     }'

{
    "Error": false,
    "Message": "SUCCESS",
    "Body": "Subscription deleted"
}