Usage Instructions
Integrate Email Bison into workflows. Create and update leads, manage campaigns, attach leads to campaigns, list replies, and organize leads with tags.
Tools
emailbison_list_leads
Retrieves leads from Email Bison with optional search and tag filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Search term for filtering leads |
campaignStatus | string | No | Lead campaign status filter: in_sequence, sequence_finished, sequence_stopped, never_contacted, or replied |
tagIds | array | No | Tag IDs to include |
items | number | No | No description |
excludedTagIds | array | No | Tag IDs to exclude |
items | number | No | No description |
withoutTags | boolean | No | Only return leads without tags |
Output
This tool does not produce any outputs.
emailbison_get_lead
Retrieves a lead by Email Bison lead ID or email address.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
leadId | string | Yes | Lead ID or email address |
Output
This tool does not produce any outputs.
emailbison_create_lead
Creates a single lead in Email Bison.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
firstName | string | Yes | Lead first name |
lastName | string | Yes | Lead last name |
email | string | Yes | Lead email address |
title | string | No | Lead job title |
company | string | No | Lead company |
notes | string | No | Additional notes about the lead |
customVariables | array | No | Custom variables to store on the lead |
items | object | No | Custom variable name |
properties | string | No | Custom variable name |
name | string | No | No description |
value | string | No | No description |
Output
This tool does not produce any outputs.
emailbison_update_lead
Updates an existing Email Bison lead. Fields omitted from a PUT update may be cleared by Email Bison.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
leadId | string | Yes | Lead ID or email address |
firstName | string | Yes | Lead first name |
lastName | string | Yes | Lead last name |
email | string | Yes | Lead email address |
title | string | No | Lead job title |
company | string | No | Lead company |
notes | string | No | Additional notes about the lead |
customVariables | array | No | Custom variables to store on the lead |
items | object | No | Custom variable name |
properties | string | No | Custom variable name |
name | string | No | No description |
value | string | No | No description |
Output
This tool does not produce any outputs.
emailbison_list_campaigns
Retrieves Email Bison campaigns.
Input
| Parameter | Type | Required | Description |
|---|
Output
This tool does not produce any outputs.
emailbison_create_campaign
Creates a new Email Bison campaign.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Campaign name |
campaignType | string | No | Campaign type: outbound or reply_followup |
Output
This tool does not produce any outputs.
emailbison_update_campaign
Updates Email Bison campaign settings.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | number | Yes | Campaign ID |
name | string | No | Campaign name |
maxEmailsPerDay | number | No | Maximum emails per day |
maxNewLeadsPerDay | number | No | Maximum new leads per day |
plainText | boolean | No | Send plain text emails |
openTracking | boolean | No | Enable open tracking |
reputationBuilding | boolean | No | Enable reputation building |
canUnsubscribe | boolean | No | Enable unsubscribe link |
includeAutoRepliesInStats | boolean | No | Include auto replies in campaign stats |
sequencePrioritization | string | No | Sequence prioritization: followups or new_leads |
Output
This tool does not produce any outputs.
emailbison_update_campaign_status
Pauses, resumes, or archives an Email Bison campaign.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | number | Yes | Campaign ID |
action | string | Yes | Status action: pause, resume, or archive |
Output
This tool does not produce any outputs.
emailbison_attach_leads_to_campaign
Adds existing Email Bison leads to a campaign.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | number | Yes | Campaign ID |
leadIds | array | Yes | Lead IDs to add to the campaign |
items | number | No | No description |
allowParallelSending | boolean | No | Force add leads already in sequence in other campaigns |
Output
This tool does not produce any outputs.
emailbison_list_replies
Retrieves Email Bison replies with optional status, folder, campaign, sender, lead, and tag filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Search term for replies |
status | string | No | Reply status: interested, automated_reply, or not_automated_reply |
folder | string | No | Reply folder: inbox, sent, spam, bounced, or all |
read | boolean | No | Filter by read state |
campaignId | number | No | Campaign ID |
senderEmailId | number | No | Sender email ID |
leadId | number | No | Lead ID |
tagIds | array | No | Tag IDs to filter replies by |
items | number | No | No description |
Output
This tool does not produce any outputs.
emailbison_list_tags
Retrieves all Email Bison tags for the authenticated workspace.
Input
| Parameter | Type | Required | Description |
|---|
Output
This tool does not produce any outputs.
emailbison_create_tag
Creates a new Email Bison tag.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Tag name |
Output
This tool does not produce any outputs.
emailbison_attach_tags_to_leads
Attaches Email Bison tags to one or more leads.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
tagIds | array | Yes | Tag IDs to attach |
items | number | No | No description |
leadIds | array | Yes | Lead IDs to tag |
items | number | No | No description |
skipWebhooks | boolean | No | Skip Email Bison webhooks for this action |
Output
This tool does not produce any outputs.
Triggers
A workflow can start when one of these Email Bison events occurs.
Email Bison Email Sent
Trigger when a campaign email is sent in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ lead_id | number | Lead ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ email_subject | string | Email subject |
↳ email_body | string | Email body HTML |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Contact First Emailed
Trigger when a contact receives their first campaign email in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ lead_id | number | Lead ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ email_subject | string | Email subject |
↳ email_body | string | Email body HTML |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Contact Replied
Trigger when a campaign lead replies in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
reply | object | |
↳ id | number | Reply ID |
↳ uuid | string | Reply UUID |
↳ email_subject | string | Reply email subject |
↳ interested | boolean | Whether the reply is marked interested |
↳ automated_reply | boolean | Whether the reply is automated |
↳ html_body | string | Reply HTML body |
↳ text_body | string | Reply plain text body |
↳ raw_body | string | Raw MIME reply body |
↳ headers | string | Encoded raw email headers |
↳ date_received | string | Reply received timestamp |
↳ from_name | string | Reply sender name |
↳ from_email_address | string | Reply sender email address |
↳ primary_to_email_address | string | Primary recipient email address |
↳ to | json | Reply To recipients |
↳ cc | json | Reply CC recipients |
↳ bcc | json | Reply BCC recipients |
↳ parent_id | number | Parent reply ID |
↳ reply_type | string | Reply type |
↳ folder | string | Reply folder |
↳ raw_message_id | string | Raw email message ID |
↳ created_at | string | Reply creation timestamp |
↳ updated_at | string | Reply update timestamp |
↳ attachments | json | Reply attachments |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Contact Interested
Trigger when a reply is marked interested in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
reply | object | |
↳ id | number | Reply ID |
↳ uuid | string | Reply UUID |
↳ email_subject | string | Reply email subject |
↳ interested | boolean | Whether the reply is marked interested |
↳ automated_reply | boolean | Whether the reply is automated |
↳ html_body | string | Reply HTML body |
↳ text_body | string | Reply plain text body |
↳ raw_body | string | Raw MIME reply body |
↳ headers | string | Encoded raw email headers |
↳ date_received | string | Reply received timestamp |
↳ from_name | string | Reply sender name |
↳ from_email_address | string | Reply sender email address |
↳ primary_to_email_address | string | Primary recipient email address |
↳ to | json | Reply To recipients |
↳ cc | json | Reply CC recipients |
↳ bcc | json | Reply BCC recipients |
↳ parent_id | number | Parent reply ID |
↳ reply_type | string | Reply type |
↳ folder | string | Reply folder |
↳ raw_message_id | string | Raw email message ID |
↳ created_at | string | Reply creation timestamp |
↳ updated_at | string | Reply update timestamp |
↳ attachments | json | Reply attachments |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Contact Unsubscribed
Trigger when a contact unsubscribes in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ lead_id | number | Lead ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ email_subject | string | Email subject |
↳ email_body | string | Email body HTML |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Untracked Reply Received
Trigger when Email Bison receives a reply not tied to a scheduled campaign email
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
reply | object | |
↳ id | number | Reply ID |
↳ uuid | string | Reply UUID |
↳ email_subject | string | Reply email subject |
↳ interested | boolean | Whether the reply is marked interested |
↳ automated_reply | boolean | Whether the reply is automated |
↳ html_body | string | Reply HTML body |
↳ text_body | string | Reply plain text body |
↳ raw_body | string | Raw MIME reply body |
↳ headers | string | Encoded raw email headers |
↳ date_received | string | Reply received timestamp |
↳ from_name | string | Reply sender name |
↳ from_email_address | string | Reply sender email address |
↳ primary_to_email_address | string | Primary recipient email address |
↳ to | json | Reply To recipients |
↳ cc | json | Reply CC recipients |
↳ bcc | json | Reply BCC recipients |
↳ parent_id | number | Parent reply ID |
↳ reply_type | string | Reply type |
↳ folder | string | Reply folder |
↳ raw_message_id | string | Raw email message ID |
↳ created_at | string | Reply creation timestamp |
↳ updated_at | string | Reply update timestamp |
↳ attachments | json | Reply attachments |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Opened
Trigger when an Email Bison campaign email is opened
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ lead_id | number | Lead ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ email_subject | string | Email subject |
↳ email_body | string | Email body HTML |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Bounced
Trigger when an Email Bison campaign email bounces
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
reply | object | |
↳ id | number | Reply ID |
↳ uuid | string | Reply UUID |
↳ email_subject | string | Reply email subject |
↳ interested | boolean | Whether the reply is marked interested |
↳ automated_reply | boolean | Whether the reply is automated |
↳ html_body | string | Reply HTML body |
↳ text_body | string | Reply plain text body |
↳ raw_body | string | Raw MIME reply body |
↳ headers | string | Encoded raw email headers |
↳ date_received | string | Reply received timestamp |
↳ from_name | string | Reply sender name |
↳ from_email_address | string | Reply sender email address |
↳ primary_to_email_address | string | Primary recipient email address |
↳ to | json | Reply To recipients |
↳ cc | json | Reply CC recipients |
↳ bcc | json | Reply BCC recipients |
↳ parent_id | number | Parent reply ID |
↳ reply_type | string | Reply type |
↳ folder | string | Reply folder |
↳ raw_message_id | string | Raw email message ID |
↳ created_at | string | Reply creation timestamp |
↳ updated_at | string | Reply update timestamp |
↳ attachments | json | Reply attachments |
campaignEvent | object | |
↳ id | number | Campaign event ID |
↳ event_type | string | Campaign event type |
↳ created_at_local | string | Campaign event local creation timestamp |
↳ local_timezone | string | Campaign event local timezone |
↳ created_at | string | Campaign event creation timestamp |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | string | Interested status |
↳ raw_message_id | string | Raw email message ID |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Account Added
Trigger when a sender email account is added to Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Account Removed
Trigger when a sender email account is removed from Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Account Disconnected
Trigger when a sender email account disconnects in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Email Account Reconnected
Trigger when a sender email account reconnects in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Manual Email Sent
Trigger when a manual email is sent in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
reply | object | |
↳ id | number | Reply ID |
↳ email_subject | string | Reply email subject |
↳ interested | boolean | Whether the reply is marked interested |
↳ automated_reply | boolean | Whether the reply is automated |
↳ html_body | string | Reply HTML body |
↳ text_body | string | Reply plain text body |
↳ raw_body | string | Raw MIME reply body |
↳ headers | string | Encoded raw email headers |
↳ date_received | string | Reply received timestamp |
↳ reply_type | string | Reply type |
↳ from_name | string | Reply sender name |
↳ from_email_address | string | Reply sender email address |
↳ primary_to_email_address | string | Primary recipient email address |
↳ to | json | Reply To recipients |
↳ cc | json | Reply CC recipients |
↳ bcc | json | Reply BCC recipients |
↳ parent_id | json | Parent reply ID |
↳ folder | string | Reply folder |
↳ raw_message_id | string | Raw email message ID |
↳ created_at | string | Reply creation timestamp |
↳ updated_at | string | Reply update timestamp |
↳ attachments | json | Reply attachments |
lead | object | |
↳ id | number | Lead ID |
↳ email | string | Lead email address |
↳ first_name | string | Lead first name |
↳ last_name | string | Lead last name |
↳ status | string | Lead status |
↳ title | string | Lead title |
↳ company | string | Lead company |
↳ custom_variables | json | Lead custom variables |
↳ emails_sent | number | Lead emails sent count |
↳ opens | number | Lead open count |
↳ unique_opens | number | Lead unique open count |
↳ replies | number | Lead reply count |
↳ unique_replies | number | Lead unique reply count |
↳ bounces | number | Lead bounce count |
campaign | object | |
↳ id | number | Campaign ID |
↳ name | string | Campaign name |
scheduledEmail | object | |
↳ id | number | Scheduled email ID |
↳ sequence_step_id | number | Sequence step ID |
↳ sequence_step_order | number | Sequence step order |
↳ sequence_step_variant | number | Sequence step variant |
↳ status | string | Scheduled email status |
↳ scheduled_date_est | string | Scheduled date in EST |
↳ scheduled_date_local | string | Scheduled date in local timezone |
↳ local_timezone | string | Scheduled email local timezone |
↳ sent_at | string | Email sent timestamp |
↳ opens | number | Open count |
↳ replies | number | Reply count |
↳ unique_opens | number | Unique open count |
↳ unique_replies | number | Unique reply count |
↳ interested | json | Interested status |
↳ raw_message_id | string | Raw email message ID |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Tag Attached
Trigger when a custom tag is attached to a taggable in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
tagId | number | Email Bison tag ID |
tagName | string | Email Bison tag name |
taggableId | number | ID of the tagged resource |
taggableType | string | Type of the tagged resource |
Email Bison Tag Removed
Trigger when a custom tag is removed from a taggable in Email Bison
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
tagId | number | Email Bison tag ID |
tagName | string | Email Bison tag name |
taggableId | number | ID of the tagged resource |
taggableType | string | Type of the tagged resource |
Email Bison Warmup Disabled Receiving Bounces
Trigger when warmup is disabled for a sender email receiving too many bounces
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |
Email Bison Warmup Disabled Causing Bounces
Trigger when warmup is disabled for a sender email causing too many bounces
Email Bison sends the event to the webhook URL shown in the block.
Configuration
| Field | Type | Description |
|---|---|---|
| API Key | text | No description |
| Instance URL | text | No description |
Output
| Field | Type | Description |
|---|---|---|
eventType | string | Email Bison webhook event type |
eventName | string | Human-readable Email Bison event name |
instanceUrl | string | Email Bison instance URL |
workspaceId | number | Email Bison workspace ID |
workspaceName | string | Email Bison workspace name |
event | json | Raw Email Bison event metadata object |
data | json | Raw Email Bison event data object |
senderEmail | object | |
↳ id | number | Sender email ID |
↳ name | string | Sender email name |
↳ email | string | Sender email address |
↳ status | string | Sender email status |
↳ account_type | string | Sender email connection type |
↳ daily_limit | number | Sender email daily limit |
↳ emails_sent | number | Sender email sent count |
↳ replied | number | Sender email replied count |
↳ opened | number | Sender email opened count |
↳ unsubscribed | number | Sender email unsubscribed count |
↳ bounced | number | Sender email bounced count |
↳ unique_replies | number | Sender email unique reply count |
↳ unique_opens | number | Sender email unique open count |
↳ total_leads_contacted | number | Sender email total leads contacted |
↳ interested | number | Sender email interested count |
↳ created_at | string | Sender email creation timestamp |
↳ updated_at | string | Sender email update timestamp |