Webhooks

Send form submissions to any URL in real-time. Build custom integrations with ease.

What are Webhooks?

Webhooks allow you to send form submission data to any URL automatically when a form is submitted.

Setting Up a Webhook

1. 1Go to your form's Integrations tab
2. 2Click Add Integration and select Webhook
3. 3Enter your webhook URL (must be HTTPS)
4. 4Optionally add authentication headers
5. 5Test the webhook and enable it

Payload Format

Webhooks send a POST request with a JSON body:

{
  "event": "submission.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "form_id": "550e8400-e29b-41d4-a716-446655440000",
    "form_title": "Contact Form",
    "form_slug": "contact",
    "submission_id": "660e8400-e29b-41d4-a716-446655440001",
    "submission_data": {
      "email": "john@example.com",
      "name": "John Doe",
      "message": "Hello, I have a question..."
    },
    "submitted_at": "2024-01-15T10:30:00Z",
    "metadata": {
      "referrer": "https://yoursite.com/contact",
      "device_type": "desktop",
      "utm_source": "google"
    }
  }
}

Secure your webhook endpoint by adding authentication headers:

If your webhook endpoint returns an error, Orbit AI will automatically retry up to 3 times with 1-minute intervals between attempts.

Your endpoint should return a 2xx status code to indicate success.