Event Types - FoxReach API

Available Events

Subscribe to any combination of these event types when creating or updating a webhook. Every delivery is a POST request whose JSON body has four top-level fields: id (the event ID), type (the event type), payload (event-specific data, shown per event below), and timestamp (ISO 8601 creation time). The examples below omit id for brevity.

Email Events

event

Fired when an email is successfully sent from a campaign sequence.

{
  "type": "email.sent",
  "timestamp": "2025-01-15T10:30:00Z",
  "payload": {
    "emailLogId": "cel_123",
    "campaignId": "cmp_456",
    "leadId": "cld_789",
    "toEmail": "[email protected]",
    "fromEmail": "[email protected]",
    "subject": "Quick question",
    "sequenceStep": 1
  }
}

event

Fired when an email fails to send (SMTP error, authentication issue, etc.).

{
  "type": "email.failed",
  "timestamp": "2025-01-15T10:30:00Z",
  "payload": {
    "emailLogId": "cel_123",
    "campaignId": "cmp_456",
    "leadId": "cld_789",
    "toEmail": "[email protected]",
    "error": "SMTP connection timeout"
  }
}

event

Fired when a sent email bounces back.

{
  "type": "email.bounced",
  "timestamp": "2025-01-15T10:30:00Z",
  "payload": {
    "emailLogId": "cel_123",
    "campaignId": "cmp_456",
    "leadId": "cld_789",
    "toEmail": "[email protected]",
    "bounceType": "hard"
  }
}

event

Fired when a recipient opens a tracked email.

{
  "type": "email.opened",
  "timestamp": "2025-01-15T14:22:00Z",
  "payload": {
    "emailLogId": "cel_123",
    "campaignId": "cmp_456",
    "leadId": "cld_789",
    "toEmail": "[email protected]"
  }
}

Reply Events

event

Fired when a reply is received and matched to a lead/campaign.

{
  "type": "reply.received",
  "timestamp": "2025-01-15T15:00:00Z",
  "payload": {
    "replyId": "crp_123",
    "campaignId": "cmp_456",
    "leadId": "cld_789",
    "fromEmail": "[email protected]",
    "subject": "Re: Quick question",
    "bodyPreview": "Thanks for reaching out..."
  }
}

event

Fired when a reply is categorized (by AI or manually).

{
  "type": "reply.categorized",
  "timestamp": "2025-01-15T15:01:00Z",
  "payload": {
    "replyId": "crp_123",
    "category": "interested",
    "previousCategory": "uncategorized"
  }
}

Campaign Events

event

Fired when a campaign transitions to active status.

{
  "type": "campaign.started",
  "timestamp": "2025-01-15T09:00:00Z",
  "payload": {
    "campaignId": "cmp_456",
    "name": "Q1 Outreach",
    "totalLeads": 500
  }
}

event

Fired when a campaign is paused.

{
  "type": "campaign.paused",
  "timestamp": "2025-01-15T16:00:00Z",
  "payload": {
    "campaignId": "cmp_456",
    "name": "Q1 Outreach"
  }
}

event

Fired when all leads in a campaign have been processed.

{
  "type": "campaign.completed",
  "timestamp": "2025-02-01T12:00:00Z",
  "payload": {
    "campaignId": "cmp_456",
    "name": "Q1 Outreach",
    "totalSent": 1500,
    "totalReplied": 45,
    "totalBounced": 12
  }
}

Lead Events

event

Fired when a new lead is created (via API, CSV import, or manually).

{
  "type": "lead.created",
  "timestamp": "2025-01-15T10:00:00Z",
  "payload": {
    "leadId": "cld_789",
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "source": "api"
  }
}

event

Fired when a lead’s information is updated.

{
  "type": "lead.updated",
  "timestamp": "2025-01-15T10:05:00Z",
  "payload": {
    "leadId": "cld_789",
    "updatedFields": ["company", "title"]
  }
}

Listing Available Events

You can also retrieve the list of supported event types programmatically:

curl https://api.foxreach.io/api/v1/webhooks/events \
  -H "X-API-Key: otr_your_key"

​Available Events

​Email Events

​Reply Events

​Campaign Events

​Lead Events

​Listing Available Events

Available Events

Email Events

Reply Events

Campaign Events

Lead Events

Listing Available Events