Skip to main content
GET
List Test Events

Overview

Get a list of available webhook event types that can be used for testing. This endpoint returns all supported webhook events with their identifiers and descriptions, useful for webhook configuration and testing.

Use Cases

  • Webhook Setup: Discover available event types during webhook configuration
  • Testing Preparation: Identify which events to test for your integration
  • Documentation: Reference event types for webhook development
  • Validation: Verify supported events before creating webhooks

Response Structure

The response includes an array of available webhook events with their details:

Testing Example

Event Categories

Prospect Events

Events related to prospect interactions and status changes:
  • prospect.qualified - Prospect marked as qualified
  • prospect.responded - Prospect responded to outreach
  • prospect.disqualified - Prospect marked as disqualified
  • prospect.paused - Prospect conversation paused
  • prospect.resumed - Prospect conversation resumed

Campaign Events

Events related to campaign lifecycle and status:
  • campaign.started - Campaign activated and started
  • campaign.paused - Campaign paused
  • campaign.resumed - Campaign resumed
  • campaign.completed - Campaign completed
  • campaign.deleted - Campaign deleted

Message Events

Events related to message sending and responses:
  • message.sent - Message sent to prospect
  • message.failed - Message sending failed
  • message.received - Response received from prospect
  • message.scheduled - Message scheduled for sending

Connection Events

Events related to LinkedIn connection activities:
  • connection.sent - Connection request sent
  • connection.accepted - Connection request accepted
  • connection.rejected - Connection request rejected
  • connection.withdrawn - Connection request withdrawn

Agent Events

Events related to agent status and health:
  • agent.status_changed - Agent status changed
  • agent.health_alert - Agent health alert triggered
  • agent.limits_reached - Agent daily limits reached
  • agent.offline - Agent went offline

Integration Examples

Event Selection for Webhook Creation

Dynamic Event Configuration

Best Practices

  1. Event Selection: Choose only the events your application needs
  2. Category Filtering: Use categories to organize event subscriptions
  3. Validation: Always validate event IDs before webhook creation
  4. Documentation: Keep a reference of event types for your team
  5. Testing: Use this endpoint to plan your webhook testing strategy

Next Steps

After getting the list of test events:
  1. Select Events: Choose relevant events for your integration
  2. Get Examples: Use /webhooks/test/example/{event} to see payload examples
  3. Create Webhook: Create webhook with selected events
  4. Test Integration: Use /webhooks/test to send test events
  5. Monitor: Set up monitoring for webhook delivery and processing

Authorizations

Authorization
string
header
required

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

Response

List of available test events

id
string
Example:

"prospect.qualified"

name
string
Example:

"Prospect Qualified"

description
string
Example:

"Triggered when a prospect is marked as qualified"

category
string
Example:

"prospect"

Last modified on August 29, 2025