Documentation Index
Fetch the complete documentation index at: https://docs.inboxapp.com/llms.txt
Use this file to discover all available pages before exploring further.
{
"id": "ck9v2m5nj0xp4wq7ybftrae8",
"seq": 312,
"teamId": "hzcai5t59nn9vsck3rbuepyg",
"type": "campaign.started",
"timestamp": "2025-01-16T09:00:00.000Z",
"version": "1.0",
"data": {
"campaign": {
"id": "w4h36qm5d9iu2sgdf6jbn7kx",
"name": "Q1 Product Launch Outreach",
"description": "Reaching out to design leaders about our new collaboration features",
"status": "active",
"dryRun": false,
"targetsCount": 250,
"contactedCount": 0,
"repliesCount": 0,
"completionRate": 0,
"replyRate": 0,
"createdAt": "2025-01-15T14:00:00.000Z",
"updatedAt": "2025-01-16T09:00:00.000Z",
"pausedAt": null,
"completedAt": null,
"lastStartedAt": "2025-01-16T09:00:00.000Z"
}
}
}
When it fires
- A campaign is started for the first time from the Inbox UI
- A paused campaign is resumed (also triggers
campaign.resumed)
When a campaign starts, its status transitions to "active" and lastStartedAt is set to the current timestamp.
Payload
The campaign object.
The campaign description.
The campaign status. One of draft, active, paused, or completed.
Whether the campaign is in dry run mode (no messages actually sent).
Total number of targets in the campaign.
Number of targets that have been contacted.
Number of targets that have replied.
Percentage of targets contacted (0–1).
Percentage of contacted targets that replied (0–1).
ISO 8601 timestamp of when the campaign was created.
ISO 8601 timestamp of the last update, or null.
ISO 8601 timestamp of when the campaign was paused, or null.
ISO 8601 timestamp of when the campaign completed, or null.
ISO 8601 timestamp of when the campaign was last started, or null.
