campaign.paused

{
  "id": "ck9v2m5nj0xp4wq7ybftrae8",
  "seq": 312,
  "teamId": "hzcai5t59nn9vsck3rbuepyg",
  "type": "campaign.paused",
  "timestamp": "2025-01-16T09:15:00.000Z",
  "version": "1.0",
  "data": {
    "campaign": {
      "id": "x9wq5p2bvnhfdteolyr3km7j",
      "name": "Q1 Agency Outreach",
      "description": "Reaching out to design agencies in the Bay Area",
      "status": "paused",
      "dryRun": false,
      "targetsCount": 250,
      "contactedCount": 87,
      "repliesCount": 12,
      "completionRate": 0.348,
      "replyRate": 0.138,
      "createdAt": "2025-01-10T09:00:00.000Z",
      "updatedAt": "2025-01-16T09:15:00.000Z",
      "pausedAt": "2025-01-16T09:15:00.000Z",
      "completedAt": null,
      "lastStartedAt": "2025-01-12T08:00:00.000Z"
    }
  }
}

When it fires

A running campaign is paused — either manually by a team member through the Inbox UI, or automatically by the system (e.g., if the connected account encounters an issue). While paused, the campaign stops contacting new targets and stops sending follow-up messages. Existing conversations remain active.

Payload

campaign

Campaign

required

The campaign object.

Show properties

string

The Inbox campaign ID.

name

string

The campaign name.

description

string | null

The campaign description.

status

string

The campaign status. One of draft, active, paused, or completed.

dryRun

boolean

Whether the campaign is in dry run mode (no messages actually sent).

targetsCount

number

Total number of targets in the campaign.

contactedCount

number

Number of targets that have been contacted.

repliesCount

number

Number of targets that have replied.

completionRate

number

Percentage of targets contacted (0–1).

replyRate

number

Percentage of contacted targets that replied (0–1).

createdAt

string

ISO 8601 timestamp of when the campaign was created.

updatedAt

string | null

ISO 8601 timestamp of the last update, or null.

pausedAt

string | null

ISO 8601 timestamp of when the campaign was paused, or null.

completedAt

string | null

ISO 8601 timestamp of when the campaign completed, or null.

lastStartedAt

string | null

ISO 8601 timestamp of when the campaign was last started, or null.

Webhooks

Event types

When it fires

Payload

​When it fires

​Payload

When it fires

Payload