Webhook Setup Guide

What are Webhooks?

Webhooks are automated messages sent from one system to another when something happens. Think of them as "push notifications for servers" - instead of constantly checking for updates, your AI agent receives data instantly when an event occurs.

Getting Your Webhook URL

Every agent gets a unique webhook URL that you can use to trigger it. Here's how to find it:

Sending Data to Your Webhook

Webhooks accept data via HTTP POST requests with JSON body. Here's the format:

POST https://agents.inteliworks.com/webhook/wh_a1b2c3d4e5f6g7h8
Content-Type: application/json

{
  "name": "John Smith",
  "email": "john@example.com",
  "company": "Acme Corp",
  "message": "I'm interested in your enterprise plan",
  "source": "contact_form"
}

Data Field Mapping

Your agent automatically maps common field names. Here are the supported fields:

Webhook Authentication

For additional security, you can require authentication on your webhooks. We support two methods:

Enabling Authentication

1. Go to your agent's Settings page
2. Find the "Webhook Security" section
3. Choose your authentication method
4. Copy the generated API key or signing secret
5. Add the appropriate header to your webhook requests

Testing Your Webhook

Before going live, test your webhook to make sure everything is configured correctly.

Using cURL

curl -X POST https://agents.inteliworks.com/webhook/wh_a1b2c3d4e5f6g7h8 \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "name": "Test User",
    "email": "test@example.com",
    "company": "Test Corp",
    "message": "This is a test message"
  }'

Expected Response

{
  "success": true,
  "executionId": "exec_xyz789",
  "message": "Webhook received, agent triggered"
}

Using the Built-in Tester

You can also test directly from your dashboard:

1. Go to your agent's settings page
2. Click "Test Webhook"
3. Fill in sample data or use a template
4. Click "Send Test" and watch the execution logs

Common Integration Examples

Troubleshooting