Available events
Prospect created
Sent once a new prospect is inserted to the database. Whenever a prospect is created within a campaign, the campaign data will be included as an additional field.
{
"event": "prospects.created",
"prospect": {
"id": 63,
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"source": "app",
"email": "jane@example.com",
"email_type": null,
"phone": "+12025051237",
"phone_type": "mobile",
"status": "active",
"address": "NY",
"city": "New York",
"birthday": "2000-04-17",
"state": "NY",
"zip": "10001",
"assigned_to": 4,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T10:43:40.000000Z",
"updated_at": "2023-06-26T10:43:40.000000Z",
"business": {
"id": 2,
"name": "My business"
},
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": {
"campaign": {
"id": 1,
"name": "Example",
"lead_zapier_uuid": null,
"created_at": "2023-06-26T09:08:13.000000Z",
"updated_at": "2023-06-26T09:08:13.000000Z",
"prospects_count": null,
"sequence": {
"id": 1,
"name": "Example",
"campaign_id": 1,
"enabled": true,
"enable_date": null,
"type": "day_based",
"prospect_zapier_uuid": null,
"locked": 0,
"is_template": false,
"round_robin": false,
"stop_on_response": true,
"cutoff_start": "09:00:00",
"cutoff_stop": "17:00:00",
"enabled_days": [
0,
1,
2,
3,
4
],
"nudge_enabled": 0,
"replies": {
"forward_sms": false
},
"loop": {
"delay": null,
"campaign_id": null
},
"created_at": "2023-06-26T09:08:16.000000Z",
"updated_at": "2023-06-26T09:08:22.000000Z"
}
}
},
"resource": null
}Prospect updated
Sent once a prospect's data is updated.
{
"event": "prospects.updated",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"business": {
"id": 2,
"name": "My business"
},
"assignee": {
"id": 3,
"name": "Jane Smith",
"email": "test@getbonzo.com",
"phone": null,
"avatar_url": null
},
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": [],
"resource": null
}New incoming message
Sent once a new message is received.
{
"event": "messages.incoming.created",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T10:00:31.000000Z",
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": {
"message": {
"id": 1,
"campaign_id": null,
"sequence_id": null,
"prospect_id": 61,
"user_id": 3,
"conversationalist_id": null,
"type": "sms",
"subject": null,
"content": "Example message text",
"status": "delivered",
"response_time": null,
"call_duration": null,
"created_at": "2023-06-26T09:31:10.000000Z",
"updated_at": "2023-06-26T09:31:11.000000Z",
"event_date": "2023-06-26 09:31:10",
"event_id": null,
"pipeline_event_id": null,
"image_path": null,
"audio_path": null,
"source": "direct",
"batch_id": null,
"deleted_at": null,
"send_at": null,
"error_message": null,
"email_message_id": null,
"thread_id": null,
"external_id": null,
"business_id": 2,
"segments": 0
},
"dnc": false
},
"resource": null
}New outgoing message
Sent once a message is sent.
{
"event": "messages.outgoing.created",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"business": {
"id": 2,
"name": "My business"
},
"assignee": {
"id": 3,
"name": "Jane Smith",
"email": "test@getbonzo.com",
"phone": null,
"avatar_url": null
},
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": {
"message": {
"id": 1,
"campaign_id": null,
"prospect_id": 11,
"type": "sms",
"content": "Example message text",
"subject": null,
"prospect": {
"id": 11
},
"source": "direct",
"status": "sent",
"direction": "outgoing",
"user_name": "Jane Smith",
"avatar_url": null,
"event_id": null,
"error_message": null,
"image_path": null,
"audio_path": null,
"created_at": "2023-06-26T09:31:10.000000Z",
"updated_at": "2023-06-26T09:31:10.000000Z",
"send_at": null,
"conversationalist_id": null
}
},
"resource": null
}Campaign switched
Sent once a prospect is moved to a campaign.
{
"event": "prospects.campaigns.updated",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"business": {
"id": 2,
"name": "My business"
},
"assignee": {
"id": 3,
"name": "Jane Smith",
"email": "test@getbonzo.com",
"phone": null,
"avatar_url": null
},
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": {
"campaign": {
"id": 1,
"name": "Example",
"lead_zapier_uuid": null,
"created_at": "2023-06-26T09:08:13.000000Z",
"updated_at": "2023-06-26T09:08:13.000000Z",
"prospects_count": null,
"sequence": {
"id": 1,
"name": "Example",
"campaign_id": 1,
"enabled": true,
"enable_date": null,
"type": "day_based",
"prospect_zapier_uuid": null,
"locked": 0,
"is_template": false,
"round_robin": false,
"stop_on_response": true,
"cutoff_start": "09:00:00",
"cutoff_stop": "17:00:00",
"enabled_days": [
0,
1,
2,
3,
4
],
"nudge_enabled": 0,
"replies": {
"forward_sms": false
},
"loop": {
"delay": null,
"campaign_id": null
},
"created_at": "2023-06-26T09:08:16.000000Z",
"updated_at": "2023-06-26T09:08:22.000000Z"
}
}
},
"resource": null
}Pipeline stage switched
Sent once a prospect is moved to a stage of a pipeline.
{
"event": "prospects.pipeline_stages.updated",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T10:00:31.000000Z",
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": {
"pipeline": {
"id": 1,
"business_id": 2,
"name": "Example pipeline",
"description": null,
"order": 0,
"is_default": false,
"is_template": false,
"business_tag": null,
"start": "09:00:00",
"end": "17:00:00",
"local_timezone": false,
"exclude_national_holidays": false,
"public_access": 1,
"created_at": "2023-06-26T09:50:11.000000Z",
"updated_at": "2023-06-26T09:50:11.000000Z"
},
"pipelineStage": {
"id": 1,
"pipeline_id": 1,
"campaign_id": null,
"sequence_id": 1,
"name": "First stage",
"color": null,
"order": 0,
"notification_period": 1,
"points_to": null,
"is_collapsed": 0,
"created_at": "2023-06-26T09:50:13.000000Z",
"updated_at": "2023-06-26T09:52:03.000000Z",
"move_stage_id": null,
"move_days": null,
"tags": null,
"pipeline": {
"id": 1,
"business_id": 2,
"user_id": 3,
"name": "Example pipeline",
"description": null,
"cumulative_column": null,
"order": 0,
"is_default": false,
"is_template": false,
"is_public": true,
"is_locked": false,
"business_tag": null,
"start": "09:00:00",
"end": "17:00:00",
"local_timezone": false,
"exclude_national_holidays": false,
"type": 0,
"created_at": "2023-06-26T09:50:11.000000Z",
"updated_at": "2023-06-26T09:50:11.000000Z",
"enabled": 0,
"public_access": 1,
"ensure_unique_events": 0
},
"sequence": {
"id": 1,
"uuid": null,
"campaign_id": 1,
"name": "Example",
"business_tag": null,
"enabled": true,
"round_robin": 0,
"stop_on_response": true,
"zapier_uuid": null,
"created_at": "2023-06-26T09:08:16.000000Z",
"updated_at": "2023-06-26T09:08:22.000000Z",
"cutoff_start": "09:00:00",
"cutoff_stop": "17:00:00",
"reply_to_phone": null,
"forward_sms": false,
"is_template": false,
"locked": 0,
"loop_days": null,
"loop_id": null,
"overwrite_assignee": 0,
"enable_date": null,
"business_entity_id": null,
"deleted_at": null,
"type": "consequtive",
"description": null,
"buffer_email": null,
"buffer_sms": null,
"tag": null,
"pipeline_stage_id": null,
"locked_for_team_members": 0,
"email_provider_type": 0,
"campaign": {
"id": 1,
"business_entity_id": 2,
"name": "Example",
"zapier_uuid": null,
"type": "consequtive",
"user_id": 3,
"local_timezone": 0,
"created_at": "2023-06-26T09:08:13.000000Z",
"updated_at": "2023-06-26T09:08:13.000000Z",
"deleted_at": null,
"disclaimer_disabled": 0,
"conversationalist_disabled": 1,
"nudge_enabled": 0,
"exclude_national_holidays": 0,
"pipeline_stage_id": null,
"ring_all_enabled": 0,
"sequence": {
"id": 1,
"uuid": null,
"campaign_id": 1,
"name": "Example",
"business_tag": null,
"enabled": true,
"round_robin": 0,
"stop_on_response": true,
"zapier_uuid": null,
"created_at": "2023-06-26T09:08:16.000000Z",
"updated_at": "2023-06-26T09:08:22.000000Z",
"cutoff_start": "09:00:00",
"cutoff_stop": "17:00:00",
"reply_to_phone": null,
"forward_sms": false,
"is_template": false,
"locked": 0,
"loop_days": null,
"loop_id": null,
"overwrite_assignee": 0,
"enable_date": null,
"business_entity_id": null,
"deleted_at": null,
"type": "consequtive",
"description": null,
"buffer_email": null,
"buffer_sms": null,
"tag": null,
"pipeline_stage_id": null,
"locked_for_team_members": 0,
"email_provider_type": 0,
"pipeline_stage": null
},
"business": {
"id": 2,
"parent_id": 1,
"independent_billing": 0,
"inherit_billing": 0,
"is_enterprise": 0,
"name": "My business",
"is_active": 1,
"email_disclaimer": null,
"sms_disclaimer": "Reply STOP to unsubscribe",
"sequence_timezone": "America/New_York",
"custom_fields": null,
"sequence_settings": null,
"conversationalist_disabled": false,
"default_sender": "owner",
"created_at": "2023-06-14T09:54:48.000000Z",
"updated_at": "2023-06-26T09:12:13.000000Z",
"deleted_at": null,
"stripe_id": "cus_O50QAKQDwvyD3Q",
"pm_type": null,
"pm_last_four": null,
"trial_ends_at": null,
"active_until": "2123-06-14",
"account_type": "normal",
"setup_fee_paid": false,
"retroactive_billing": 0,
"cost_per_prospect": 40,
"conversationalist_cost_per_prospect": 600,
"logo_url": null,
"surpassed_at": null,
"locked_disclaimer": false,
"unsubscribe_word": "unsubscribe",
"voicemail_sms": null,
"weekly_summary": true,
"weekly_summary_email": null,
"nurturing_campaign_id": null,
"disallow_shared_duplicates": false,
"billing_version": 3,
"twilio_account_id": 0,
"twilio_business_profile_id": null,
"billing_type": 0,
"tokens": 0
}
}
}
}
},
"resource": null
}Task created
Sent once a new task is created.
{
"event": "tasks.created",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": [],
"resource": {
"resource_type": "task",
"id": 33,
"prospect_id": 61,
"owner_id": 3,
"business_id": 2,
"assignee_id": null,
"is_conversationalist": 0,
"event_id": null,
"type": "birthday",
"frequency": "annually",
"priority": 0,
"date": "2023-08-27",
"time": "09:00:00",
"title": "John Doe Birthday",
"details": null,
"remind_before": null,
"calendar_sync": 0,
"calendar_integration_type": null,
"calendar_integration_id": null,
"length": 15,
"notification_channels": "email",
"completed_at": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"prospect": {
"id": 61,
"business_entity_id": 2,
"full_name": "John Doe",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"avatar": null
},
"business": {
"id": 2,
"name": "My business"
}
}
}Task updated
Sent once an existing task is updated.
{
"event": "tasks.updated",
"prospect": {
"id": 61,
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"source": "app",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"status": "active",
"address": "Example street 1",
"city": "New York",
"birthday": "1980-08-27",
"state": "NY",
"zip": "10001",
"assigned_to": 3,
"campaigns": {
"1": "Example"
},
"tags": [],
"dnc": false,
"last_response": null,
"last_contact": null,
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:10:03.000000Z",
"avatar": null,
"unit_number": null,
"marital_status": null,
"pipeline_prospects_count": null
},
"additional": [],
"resource": {
"resource_type": "task",
"id": 33,
"prospect_id": 61,
"owner_id": 3,
"business_id": 2,
"assignee_id": null,
"is_conversationalist": 0,
"event_id": null,
"type": "birthday",
"frequency": null,
"priority": 0,
"date": "2023-08-27",
"time": "09:00:00",
"title": "John Doe Birthday",
"details": null,
"remind_before": null,
"calendar_sync": 0,
"calendar_integration_type": null,
"calendar_integration_id": null,
"length": 15,
"notification_channels": "email",
"completed_at": "2023-06-26T09:20:14.000000Z",
"created_at": "2023-06-26T09:10:03.000000Z",
"updated_at": "2023-06-26T09:20:14.000000Z",
"prospect": {
"id": 61,
"business_entity_id": 2,
"full_name": "John Doe",
"email": "john@example.com",
"email_type": null,
"phone": "+12025051231",
"phone_type": "mobile",
"avatar": null
},
"items": [],
"business": {
"id": 2,
"name": "My business"
}
}
}