Get Test Event Example

Overview

Get an example payload for a specific webhook event type. This endpoint returns a realistic sample of what your webhook endpoint will receive when the specified event occurs, helping you develop and test your webhook integration.

Path Parameters

event

string

required

The event type to get an example for (e.g., “prospect.qualified”, “campaign.completed”)

Use Cases

Integration Development: Understand the structure of webhook payloads
Testing Setup: Create test data for webhook endpoint development
Documentation: Generate examples for your own API documentation
Validation: Verify your webhook handler can process the expected data

Example Responses

Prospect Qualified Event

GET /webhooks/test/example/prospect.qualified

{
  "event": "prospect.qualified",
  "timestamp": "2024-01-20T15:30:00Z",
  "data": {
    "prospect": {
      "id": "prospect_123",
      "name": "John Smith",
      "email": "john.smith@techcorp.com",
      "headline": "VP of Sales at TechCorp",
      "url": "https://linkedin.com/in/johnsmith",
      "location": {
        "city": "San Francisco",
        "country": "United States"
      },
      "qualification": "qualified",
      "qualifiedAt": "2024-01-20T15:30:00Z",
      "qualifiedBy": "agent_456"
    },
    "campaign": {
      "id": "campaign_789",
      "name": "Enterprise Outreach Q4"
    },
    "conversation": {
      "id": "chat_101112",
      "messageCount": 5,
      "lastMessage": "Thanks for the information! I'd love to schedule a call.",
      "lastActivity": "2024-01-20T15:25:00Z"
    }
  },
  "team": {
    "id": "team_abc",
    "name": "Sales Team Alpha"
  }
}

Campaign Completed Event

GET /webhooks/test/example/campaign.completed

{
  "event": "campaign.completed",
  "timestamp": "2024-01-20T18:00:00Z",
  "data": {
    "campaign": {
      "id": "campaign_789",
      "name": "Enterprise Outreach Q4",
      "status": "completed",
      "completedAt": "2024-01-20T18:00:00Z",
      "duration": "45 days",
      "stats": {
        "prospects": 150,
        "messages": 420,
        "responses": 35,
        "qualified": 12,
        "closed": 8,
        "conversionRate": 8.0,
        "responseRate": 23.33
      }
    },
    "agent": {
      "id": "agent_456",
      "name": "Sales Agent - West Coast"
    }
  },
  "team": {
    "id": "team_abc",
    "name": "Sales Team Alpha"
  }
}

Message Sent Event

GET /webhooks/test/example/message.sent

{
  "event": "message.sent",
  "timestamp": "2024-01-20T14:15:00Z",
  "data": {
    "message": {
      "id": "message_555",
      "content": "Hi John, I noticed your work at TechCorp and thought you might be interested in our enterprise solution...",
      "type": "initial",
      "sentAt": "2024-01-20T14:15:00Z",
      "platform": "linkedin"
    },
    "prospect": {
      "id": "prospect_123",
      "name": "John Smith",
      "headline": "VP of Sales at TechCorp",
      "url": "https://linkedin.com/in/johnsmith"
    },
    "campaign": {
      "id": "campaign_789",
      "name": "Enterprise Outreach Q4"
    },
    "agent": {
      "id": "agent_456",
      "name": "Sales Agent - West Coast"
    }
  },
  "team": {
    "id": "team_abc",
    "name": "Sales Team Alpha"
  }
}

Testing Examples

# Get example for prospect qualified event
curl -X GET "https://api.kakiyo.com/v1/webhooks/test/example/prospect.qualified" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

# Get example for campaign completed event
curl -X GET "https://api.kakiyo.com/v1/webhooks/test/example/campaign.completed" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

// JavaScript/Node.js
const getEventExample = async (eventType) => {
  const response = await fetch(`https://api.kakiyo.com/v1/webhooks/test/example/${eventType}`, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    }
  });

  return await response.json();
};

// Get examples for multiple events
const getMultipleExamples = async (eventTypes) => {
  const examples = {};
  
  for (const eventType of eventTypes) {
    try {
      examples[eventType] = await getEventExample(eventType);
    } catch (error) {
      console.error(`Failed to get example for ${eventType}:`, error);
    }
  }
  
  return examples;
};

// Usage example
const examples = await getMultipleExamples([
  'prospect.qualified',
  'campaign.completed',
  'message.sent'
]);

console.log('Event Examples:', examples);

# Python
import requests

def get_event_example(event_type):
    """Get example payload for a specific event type"""
    response = requests.get(
        f'https://api.kakiyo.com/v1/webhooks/test/example/{event_type}',
        headers={
            'Authorization': 'Bearer YOUR_API_KEY',
            'Content-Type': 'application/json'
        }
    )
    
    return response.json()

def generate_test_data(event_types):
    """Generate test data for multiple event types"""
    test_data = {}
    
    for event_type in event_types:
        try:
            test_data[event_type] = get_event_example(event_type)
            print(f"✓ Generated example for {event_type}")
        except Exception as e:
            print(f"✗ Failed to get example for {event_type}: {e}")
    
    return test_data

# Usage example
event_types = [
    'prospect.qualified',
    'prospect.responded',
    'campaign.completed',
    'message.sent',
    'agent.status_changed'
]

test_data = generate_test_data(event_types)

Error Responses

Invalid Event Type

{
  "error": "invalid_event",
  "message": "Invalid event: invalid.event.type",
  "validEvents": [
    "prospect.qualified",
    "prospect.responded",
    "campaign.completed",
    "message.sent",
    "agent.status_changed"
  ]
}

Common Event Examples

Agent Status Changed

{
  "event": "agent.status_changed",
  "timestamp": "2024-01-20T16:45:00Z",
  "data": {
    "agent": {
      "id": "agent_456",
      "name": "Sales Agent - West Coast",
      "previousStatus": "running",
      "currentStatus": "paused",
      "statusChangedAt": "2024-01-20T16:45:00Z",
      "reason": "Daily limits reached"
    },
    "stats": {
      "dailyMessages": 60,
      "dailyConnections": 25,
      "dailyProfileViews": 120
    }
  },
  "team": {
    "id": "team_abc",
    "name": "Sales Team Alpha"
  }
}

Connection Accepted

{
  "event": "connection.accepted",
  "timestamp": "2024-01-20T13:20:00Z",
  "data": {
    "connection": {
      "id": "connection_777",
      "acceptedAt": "2024-01-20T13:20:00Z",
      "sentAt": "2024-01-18T10:30:00Z",
      "responseTime": "2 days, 2 hours, 50 minutes"
    },
    "prospect": {
      "id": "prospect_123",
      "name": "John Smith",
      "headline": "VP of Sales at TechCorp",
      "url": "https://linkedin.com/in/johnsmith"
    },
    "campaign": {
      "id": "campaign_789",
      "name": "Enterprise Outreach Q4"
    },
    "agent": {
      "id": "agent_456",
      "name": "Sales Agent - West Coast"
    }
  },
  "team": {
    "id": "team_abc",
    "name": "Sales Team Alpha"
  }
}

Development Workflow

1. Explore Available Events

# Get list of all available events
curl -X GET "https://api.kakiyo.com/v1/webhooks/test/events" \
  -H "Authorization: Bearer YOUR_API_KEY"

2. Get Event Examples

# Get examples for events you want to handle
curl -X GET "https://api.kakiyo.com/v1/webhooks/test/example/prospect.qualified" \
  -H "Authorization: Bearer YOUR_API_KEY"

3. Develop Webhook Handler

Use the example payloads to develop your webhook endpoint handler.

4. Test Integration

# Send test events to your webhook
curl -X POST "https://api.kakiyo.com/v1/webhooks/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{"event": "prospect.qualified"}'

Best Practices

Schema Validation: Use examples to create JSON schemas for validation
Error Handling: Plan for missing or unexpected fields
Idempotency: Handle duplicate webhook deliveries gracefully
Logging: Log webhook payloads for debugging and monitoring
Testing: Use examples to create comprehensive test suites

Integration Tips

Create Type Definitions

// TypeScript example
interface ProspectQualifiedEvent {
  event: 'prospect.qualified';
  timestamp: string;
  data: {
    prospect: {
      id: string;
      name: string;
      email: string;
      headline: string;
      url: string;
      location: {
        city: string;
        country: string;
      };
      qualification: 'qualified';
      qualifiedAt: string;
      qualifiedBy: string;
    };
    campaign: {
      id: string;
      name: string;
    };
    conversation: {
      id: string;
      messageCount: number;
      lastMessage: string;
      lastActivity: string;
    };
  };
  team: {
    id: string;
    name: string;
  };
}

Webhook Handler Template

const handleWebhook = (payload) => {
  const { event, data, timestamp, team } = payload;
  
  switch (event) {
    case 'prospect.qualified':
      return handleProspectQualified(data);
    case 'campaign.completed':
      return handleCampaignCompleted(data);
    case 'message.sent':
      return handleMessageSent(data);
    default:
      console.log(`Unhandled event type: ${event}`);
  }
};

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

event

string

required

The event type to get an example for

Response

Example event payload

event

string

Example:

"prospect.qualified"

timestamp

string<date-time>

Example:

"2024-01-20T15:30:00Z"

data

object

Event-specific data payload

team

object

Show child attributes

Documentation Index

​Overview

​Path Parameters

​Use Cases

​Example Responses

​Prospect Qualified Event

​Campaign Completed Event

​Message Sent Event

​Testing Examples

​Error Responses

​Invalid Event Type

​Common Event Examples

​Agent Status Changed

​Connection Accepted

​Development Workflow

​1. Explore Available Events

​2. Get Event Examples

​3. Develop Webhook Handler

​4. Test Integration

​Best Practices

​Integration Tips

​Create Type Definitions

​Webhook Handler Template

Authorizations

Path Parameters

Response

Overview

Path Parameters

Use Cases

Example Responses

Prospect Qualified Event

Campaign Completed Event

Message Sent Event

Testing Examples

Error Responses

Invalid Event Type

Common Event Examples

Agent Status Changed

Connection Accepted

Development Workflow

1. Explore Available Events

2. Get Event Examples

3. Develop Webhook Handler

4. Test Integration

Best Practices

Integration Tips

Create Type Definitions

Webhook Handler Template