Webhooks Overview

Webhooks allow your application to receive real-time HTTP notifications when events occur in Orbit AI.

How Webhooks Work

1Configure a webhook endpoint URL in your dashboard

2Select which events you want to receive

3When an event occurs, we send a POST request to your URL

4Your server processes the payload and returns a 2xx response

Payload Format

All webhook payloads follow this structure:

Example Payload

{
  "event": "submission.created",
  "timestamp": "2024-01-15T14:30:00Z",
  "data": {
    "form_id": "550e8400-e29b-41d4-a716-446655440000",
    "form_title": "Contact Form",
    "form_slug": "contact-form",
    "submission_id": "660e8400-e29b-41d4-a716-446655440001",
    "submission_data": {
      "email": "user@example.com",
      "name": "John Doe"
    },
    "submitted_at": "2024-01-15T14:30:00Z",
    "metadata": {
      "referrer": "https://example.com",
      "user_agent": "Mozilla/5.0...",
      "device_type": "desktop",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "spring_sale"
    }
  }
}

Learn More

Events

All available webhook events

Security

Verify webhook signatures

Best Practices

Return a 2xx response within 5 seconds
Process webhooks asynchronously for long operations
Implement idempotency to handle duplicate deliveries
Always verify the webhook signature