Webhooks

Receive real-time events

POSTVixiees sends a POST to your Webhook URL

Receive webhook events. All events POST to this single path. See multiple examples below.

Event envelope

  • eventstringrequired
    Webhook event type
    Values:contact_createdcontact_updatedcontact_deletedcontact_comment_createddocument_createdwhatsapp_receiveddeal_createddeal_updatedtask_completedincoming_callsubmitted_form_created
  • payloadone ofrequired
  • timestampinteger (int64)required
    Unix timestamp (seconds)
  • sourcestringrequired
    Origin of the event that triggered this webhook: api, user, automation, or unknown. unknown is the common case for webhook- and background-job-originated events (e.g. inbound WhatsApp/Twilio/form webhooks, Sidekiq jobs), where Current resets and no user/automation context is available. Not to be confused with Contact#source (payload.contact.source), which describes how the contact itself was created (whatsapp, form, import, etc.).
    Values:apiuserautomationunknown

Events

contact_created

Payload fields (121)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
Example event
{
  "event": "contact_created",
  "source": "unknown",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": "507f191e810c19729de860ec",
      "current_flow_step_id": "507f191e810c19729de860ed",
      "current_flow_step_since": "2024-08-15T14:30:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": "john.smith@example.com",
      "canonical_email": "john.smith@example.com",
      "phone": "+1234567890",
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [
        "+1234567891"
      ],
      "additional_emails": [
        "j.smith@example.com"
      ],
      "all_emails": [
        "john.smith@example.com",
        "j.smith@example.com"
      ],
      "all_phones": [
        "+1234567890",
        "+1234567891"
      ],
      "priority": 1,
      "source": "whatsapp",
      "last_message": "Hello, I need help with...",
      "last_message_at": "2024-08-18T10:45:00Z",
      "unread_messages": 0,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-18T10:50:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "CRM-12345",
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": false,
      "unanswered_call": false,
      "on_task": true,
      "check_tasks_pending": false,
      "ignored": false,
      "is_client": false,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": null,
      "last_successful_call_at": null,
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-18T11:00:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 2,
      "meetings_count": 1,
      "pinned_comment_id": null,
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-18T11:00:00Z",
      "deleted_at": null,
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": null,
      "deleted_email": null,
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    }
  },
  "timestamp": 1724000000
}

contact_updated

Payload fields (123)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
  • payload.actionstring
    Present only when the update has a known cause. flow_step_changed: the contact entered a flow step (a move, or its first step on creation, where the previous ids are null).
    Values:flow_step_changed
  • payload.changesobject
    Present only together with action. Maps the fields tied to the action to [previous, new]; ids are strings. flow_step_changed contains exactly current_flow_step_id and current_playbook_id (the latter may be unchanged).
Example event
{
  "event": "contact_updated",
  "source": "user",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": "507f191e810c19729de860ec",
      "current_flow_step_id": "507f191e810c19729de860ed",
      "current_flow_step_since": "2024-08-19T15:22:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": "john.smith@example.com",
      "canonical_email": "john.smith@example.com",
      "phone": "+1234567890",
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [],
      "additional_emails": [],
      "all_emails": [
        "john.smith@example.com"
      ],
      "all_phones": [
        "+1234567890"
      ],
      "priority": 2,
      "source": "whatsapp",
      "last_message": "Hello, I need help with...",
      "last_message_at": "2024-08-18T10:45:00Z",
      "unread_messages": 0,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-19T15:10:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "CRM-12345",
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": false,
      "unanswered_call": false,
      "on_task": false,
      "check_tasks_pending": false,
      "ignored": false,
      "is_client": true,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": "2024-08-19T15:15:00Z",
      "last_successful_call_at": "2024-08-19T15:00:00Z",
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-19T15:20:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 3,
      "meetings_count": 1,
      "pinned_comment_id": null,
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-19T15:22:00Z",
      "deleted_at": null,
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": null,
      "deleted_email": null,
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    },
    "action": "flow_step_changed",
    "changes": {
      "current_flow_step_id": [
        "507f191e810c19729de860ee",
        "507f191e810c19729de860ed"
      ],
      "current_playbook_id": [
        "507f191e810c19729de860ec",
        "507f191e810c19729de860ec"
      ]
    }
  },
  "timestamp": 1724100000
}

contact_deleted

Payload fields (121)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
Example event
{
  "event": "contact_deleted",
  "source": "user",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": null,
      "current_flow_step_id": null,
      "current_flow_step_since": "2024-08-15T14:30:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": null,
      "canonical_email": null,
      "phone": null,
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [
        "+1234567891"
      ],
      "additional_emails": [
        "j.smith@example.com"
      ],
      "all_emails": [
        "j.smith@example.com"
      ],
      "all_phones": [
        "+1234567891"
      ],
      "priority": 1,
      "source": "whatsapp",
      "last_message": "Hello, I need help with...",
      "last_message_at": "2024-08-18T10:45:00Z",
      "unread_messages": 0,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-18T10:50:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": null,
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": false,
      "unanswered_call": false,
      "on_task": false,
      "check_tasks_pending": false,
      "ignored": true,
      "is_client": false,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": null,
      "last_successful_call_at": null,
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-18T11:00:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 2,
      "meetings_count": 1,
      "pinned_comment_id": null,
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-20T10:00:00Z",
      "deleted_at": "2024-08-20T10:00:00Z",
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": "+1234567890",
      "deleted_email": "john.smith@example.com",
      "deleted_external_reference_id": "CRM-12345",
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    }
  },
  "timestamp": 1724150000
}

contact_comment_created

Payload fields (127)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
  • payload.commentobjectrequired
  • payload.comment.idstring
  • payload.comment.created_by_idstringnullable
  • payload.comment.contentstring
  • payload.comment.created_atstring (date-time)
  • payload.comment.updated_atstring (date-time)
Example event
{
  "event": "contact_comment_created",
  "source": "user",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": "507f191e810c19729de860ec",
      "current_flow_step_id": "507f191e810c19729de860ed",
      "current_flow_step_since": "2024-08-15T14:30:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": "john.smith@example.com",
      "canonical_email": "john.smith@example.com",
      "phone": "+1234567890",
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [
        "+1234567891"
      ],
      "additional_emails": [
        "j.smith@example.com"
      ],
      "all_emails": [
        "john.smith@example.com",
        "j.smith@example.com"
      ],
      "all_phones": [
        "+1234567890",
        "+1234567891"
      ],
      "priority": 1,
      "source": "whatsapp",
      "last_message": "Hello, I need help with...",
      "last_message_at": "2024-08-18T10:45:00Z",
      "unread_messages": 0,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-18T10:50:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "CRM-12345",
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": false,
      "unanswered_call": false,
      "on_task": true,
      "check_tasks_pending": false,
      "ignored": false,
      "is_client": false,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": null,
      "last_successful_call_at": null,
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-18T11:00:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 2,
      "meetings_count": 1,
      "pinned_comment_id": "507f1f77bcf86cd799439022",
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-19T16:30:00Z",
      "deleted_at": null,
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": null,
      "deleted_email": null,
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    },
    "comment": {
      "id": "507f1f77bcf86cd799439022",
      "created_by_id": "507f191e810c19729de860eb",
      "content": "Client requested a follow-up call next week",
      "created_at": "2024-08-19T16:30:00Z",
      "updated_at": "2024-08-19T16:30:00Z"
    }
  },
  "timestamp": 1724180000
}

document_created

Payload fields (134)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
  • payload.documentobjectrequired
  • payload.document.idstring
  • payload.document.file_file_namestringnullable
  • payload.document.file_file_sizeintegernullable
  • payload.document.file_content_typestringnullable
  • payload.document.file_fingerprintstringnullable
  • payload.document.file_updated_atstring (date-time)nullable
  • payload.document.tagstringnullable
  • payload.document.sourcestringnullable
  • payload.document.email_content_idstringnullable
  • payload.document.expiring_urlstringnullable
    Temporary download URL (expires in 5 minutes)
  • payload.document.created_atstring (date-time)
  • payload.document.updated_atstring (date-time)
Example event
{
  "event": "document_created",
  "source": "unknown",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": "507f191e810c19729de860ec",
      "current_flow_step_id": "507f191e810c19729de860ed",
      "current_flow_step_since": "2024-08-15T14:30:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": "john.smith@example.com",
      "canonical_email": "john.smith@example.com",
      "phone": "+1234567890",
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [
        "+1234567891"
      ],
      "additional_emails": [
        "j.smith@example.com"
      ],
      "all_emails": [
        "john.smith@example.com",
        "j.smith@example.com"
      ],
      "all_phones": [
        "+1234567890",
        "+1234567891"
      ],
      "priority": 1,
      "source": "whatsapp",
      "last_message": "Hello, I need help with...",
      "last_message_at": "2024-08-18T10:45:00Z",
      "unread_messages": 0,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-18T10:50:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "CRM-12345",
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": false,
      "unanswered_call": false,
      "on_task": true,
      "check_tasks_pending": false,
      "ignored": false,
      "is_client": false,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": null,
      "last_successful_call_at": null,
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-18T11:00:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 2,
      "meetings_count": 1,
      "pinned_comment_id": null,
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-19T17:00:00Z",
      "deleted_at": null,
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": null,
      "deleted_email": null,
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    },
    "document": {
      "id": "507f1f77bcf86cd799439033",
      "file_file_name": "contract.pdf",
      "file_file_size": 245678,
      "file_content_type": "application/pdf",
      "file_fingerprint": "abc123def456",
      "file_updated_at": "2024-08-19T17:00:00Z",
      "tag": "contract",
      "source": "whatsapp",
      "email_content_id": null,
      "expiring_url": "https://cdn.vixiees.com/documents/contract.pdf?expires=1724182000&signature=xyz",
      "created_at": "2024-08-19T17:00:00Z",
      "updated_at": "2024-08-19T17:00:00Z"
    }
  },
  "timestamp": 1724182000
}

whatsapp_received

Payload fields (122)
  • payload.contactobjectrequired
  • payload.contact.idstring
    Unique contact identifier
  • payload.contact.account_idstring
    Account this contact belongs to
  • payload.contact.assignee_idstringnullable
    ID of the user assigned to this contact
  • payload.contact.current_playbook_idstringnullable
    Current playbook (sales workflow) the contact is in
  • payload.contact.current_flow_step_idstringnullable
    Current stage within the playbook
  • payload.contact.current_flow_step_sincestring (date-time)nullable
    When contact entered current flow step
  • payload.contact.contact_import_idstringnullable
    ID of the import batch if contact was imported
  • payload.contact.titlestringnullable
    Computed full name (first_name + last_name)
  • payload.contact.app_urlstringnullable
    Direct URL to view contact in Vixiees app
  • payload.contact.first_namestringnullable
  • payload.contact.last_namestringnullable
  • payload.contact.second_last_namestringnullable
  • payload.contact.emailstringnullable
    Primary email address
  • payload.contact.canonical_emailstringnullable
    Normalized email (lowercase, no aliases)
  • payload.contact.phonestringnullable
    Primary phone number in E.164 format
  • payload.contact.phone_country_codestringnullable
    ISO country code derived from phone number
  • payload.contact.invalid_phoneboolean
    True if phone number failed validation
  • payload.contact.invalid_emailboolean
    True if email address failed validation
  • payload.contact.company_namestringnullable
  • payload.contact.additional_phonesarray<string>
    Secondary phone numbers
  • payload.contact.additional_emailsarray<string>
    Secondary email addresses
  • payload.contact.all_emailsarray<string>
    All email addresses (primary + additional)
  • payload.contact.all_phonesarray<string>
    All phone numbers (primary + additional)
  • payload.contact.priorityinteger
    Contact priority (1=highest, 5=lowest). Used for task ordering.
  • payload.contact.sourcestringnullable
    How the contact was created: manual, csv, api, call, whatsapp, email, crm, web, typeform, calendly, meta_ads, tiktok_ads, bankflip
  • payload.contact.last_messagestringnullable
    Content of the most recent WhatsApp message
  • payload.contact.last_message_atstring (date-time)nullable
    When the last WhatsApp message was received
  • payload.contact.unread_messagesinteger
    Number of unread WhatsApp messages
  • payload.contact.answered_at_least_onceboolean
    True if contact has received at least one response
  • payload.contact.answered_via_callboolean
    True if contact was answered via phone call
  • payload.contact.answered_via_emailboolean
    True if contact was answered via email
  • payload.contact.answered_via_whatsappboolean
    True if contact was answered via WhatsApp
  • payload.contact.first_answer_timeintegernullable
    Seconds between contact creation and first response
  • payload.contact.first_answered_atstring (date-time)nullable
    When contact received first response
  • payload.contact.last_answered_atstring (date-time)nullable
    When contact received most recent response
  • payload.contact.whatsapp_transactional_opt_inboolean
    Consent to receive transactional WhatsApp messages
  • payload.contact.email_transactional_opt_inboolean
    Consent to receive transactional emails
  • payload.contact.whatsapp_marketing_opt_inboolean
    Consent to receive marketing WhatsApp messages
  • payload.contact.email_marketing_opt_inboolean
    Consent to receive marketing emails
  • payload.contact.external_reference_idstringnullable
    ID in external system (CRM, ERP, etc.)
  • payload.contact.external_reference_urlstringnullable
    URL to view contact in external system
  • payload.contact.bankflip_user_linkstringnullable
  • payload.contact.bankflip_documentation_area_idstringnullable
  • payload.contact.unattendedboolean
    True if contact has no assignee or pending tasks
  • payload.contact.unanswered_emailboolean
    True if contact sent email that has not been replied to
  • payload.contact.unanswered_whatsappboolean
    True if contact sent WhatsApp that has not been replied to
  • payload.contact.unanswered_callboolean
    True if contact has missed/unreturned calls
  • payload.contact.on_taskboolean
    True if contact has an active task assigned
  • payload.contact.check_tasks_pendingboolean
    True if contact has unfinished check tasks (checklist items)
  • payload.contact.ignoredboolean
    True if contact is marked as ignored/archived
  • payload.contact.is_clientboolean
    True if contact has at least one won deal
  • payload.contact.remove_requestedboolean
    True if contact requested data removal (GDPR)
  • payload.contact.last_close_won_reasonstringnullable
    Reason for most recent won deal
  • payload.contact.last_close_lost_reasonstringnullable
    Reason for most recent lost deal
  • payload.contact.mergedbooleannullable
    True if contact was merged into another contact
  • payload.contact.merged_atstring (date-time)nullable
  • payload.contact.last_closed_office_message_sent_atstring (date-time)nullable
  • payload.contact.last_assignee_atstring (date-time)nullable
    When contact was last assigned to a user
  • payload.contact.last_started_task_atstring (date-time)nullable
    When most recent task was started
  • payload.contact.last_completed_task_atstring (date-time)nullable
    When most recent task was completed
  • payload.contact.last_successful_call_atstring (date-time)nullable
    When last successful call was made
  • payload.contact.last_unsuccessful_call_atstring (date-time)nullable
    When last unsuccessful call attempt was made
  • payload.contact.last_email_sent_atstring (date-time)nullable
  • payload.contact.last_email_received_atstring (date-time)nullable
  • payload.contact.last_window_opened_atstring (date-time)nullable
    When WhatsApp 24h window was last opened
  • payload.contact.ai_controllingbooleannullable
    True if AI is currently managing this contact
  • payload.contact.ai_disabledbooleannullable
    True if AI is disabled for this contact
  • payload.contact.ai_testbooleannullable
    True if this is a test contact for AI
  • payload.contact.ai_suppressed_until_flow_step_changebooleannullable
  • payload.contact.ai_reply_count_in_stateintegernullable
  • payload.contact.deals_countinteger
    Total number of deals for this contact
  • payload.contact.meetings_countinteger
    Total number of meetings scheduled
  • payload.contact.pinned_comment_idstringnullable
    ID of comment pinned to contact profile
  • payload.contact.has_skillsbooleannullable
  • payload.contact.skillsarray<string>nullable
    Skills assigned to contact
  • payload.contact.created_atstring (date-time)
  • payload.contact.updated_atstring (date-time)
  • payload.contact.deleted_atstring (date-time)nullable
    When contact was soft-deleted
  • payload.contact.localestringnullable
    Preferred language (ISO 639-1)
  • payload.contact.country_codestringnullable
    Country code (ISO 3166-1 alpha-2)
  • payload.contact.utm_sourcestringnullable
    UTM source parameter from landing page
  • payload.contact.utm_mediumstringnullable
    UTM medium parameter from landing page
  • payload.contact.utm_campaignstringnullable
    UTM campaign parameter from landing page
  • payload.contact.utm_termstringnullable
  • payload.contact.utm_contentstringnullable
  • payload.contact.gclidstringnullable
    Google Click ID for ad attribution
  • payload.contact.fbclidstringnullable
    Meta Click ID for ad attribution
  • payload.contact.landing_page_urlstringnullable
    URL of the page where contact was captured
  • payload.contact.landing_page_querystringnullable
  • payload.contact.leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.contact.ad_idstringnullable
    ID of the Meta or TikTok ad the contact came from (see source)
  • payload.contact.ad_namestringnullable
    Name of the Meta or TikTok ad the contact came from
  • payload.contact.adgroup_idstringnullable
    ID of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.adgroup_namestringnullable
    Name of the Meta ad set or TikTok ad group the contact came from
  • payload.contact.campaign_idstringnullable
    ID of the TikTok campaign the contact came from
  • payload.contact.campaign_namestringnullable
    Name of the TikTok campaign the contact came from
  • payload.contact.tiktok_lead_idstringnullable
    TikTok lead ID of the Instant Form submission that created the contact
  • payload.contact.page_idstringnullable
    Meta page ID
  • payload.contact.page_namestringnullable
  • payload.contact.form_idstringnullable
    ID of the web form, Meta Lead Ad form or TikTok Instant Form that created this contact
  • payload.contact.deleted_phonestringnullable
  • payload.contact.deleted_emailstringnullable
  • payload.contact.deleted_external_reference_idstringnullable
  • payload.contact.deleted_crm_idstringnullable
  • payload.contact.sent_imported_email_idsarray<string>nullable
  • payload.contact.received_imported_email_idsarray<string>nullable
  • payload.contact.custom_attributesarray<CustomAttribute>
    Custom fields defined by account
  • payload.contact.custom_attributes[].idstring
  • payload.contact.custom_attributes[].field_namestring
  • payload.contact.custom_attributes[].humanized_namestring
  • payload.contact.custom_attributes[].field_typestring
  • payload.contact.custom_attributes[].editableboolean
  • payload.contact.custom_attributes[].valueany
    Typed value based on field_type
  • payload.contact.custom_attributes[].string_valuestringnullable
  • payload.contact.custom_attributes[].integer_valueintegernullable
  • payload.contact.custom_attributes[].float_valuenumbernullable
  • payload.contact.custom_attributes[].date_valuestring (date-time)nullable
  • payload.contact.custom_attributes[].boolean_valuebooleannullable
  • payload.contact.custom_attributes[].array_valuearray<string>nullable
  • payload.contact.custom_attributes[].nullableboolean
  • payload.messageanyrequired
    Raw WhatsApp message object from Twilio/WhatsApp API
Example event
{
  "event": "whatsapp_received",
  "source": "unknown",
  "payload": {
    "contact": {
      "id": "507f1f77bcf86cd799439011",
      "account_id": "507f191e810c19729de860ea",
      "assignee_id": "507f191e810c19729de860eb",
      "current_playbook_id": "507f191e810c19729de860ec",
      "current_flow_step_id": "507f191e810c19729de860ed",
      "current_flow_step_since": "2024-08-15T14:30:00Z",
      "contact_import_id": null,
      "title": "John Smith",
      "app_url": "https://app.vixiees.com/contacts/507f1f77bcf86cd799439011",
      "first_name": "John",
      "last_name": "Smith",
      "second_last_name": null,
      "email": "john.smith@example.com",
      "canonical_email": "john.smith@example.com",
      "phone": "+1234567890",
      "phone_country_code": "US",
      "invalid_phone": false,
      "invalid_email": false,
      "company_name": "Acme Corp",
      "additional_phones": [
        "+1234567891"
      ],
      "additional_emails": [
        "j.smith@example.com"
      ],
      "all_emails": [
        "john.smith@example.com",
        "j.smith@example.com"
      ],
      "all_phones": [
        "+1234567890",
        "+1234567891"
      ],
      "priority": 1,
      "source": "whatsapp",
      "last_message": "Hello, I have a question about your services",
      "last_message_at": "2024-08-19T17:20:00Z",
      "unread_messages": 1,
      "answered_at_least_once": true,
      "answered_via_call": false,
      "answered_via_email": false,
      "answered_via_whatsapp": true,
      "first_answer_time": 120,
      "first_answered_at": "2024-08-15T14:32:00Z",
      "last_answered_at": "2024-08-18T10:50:00Z",
      "whatsapp_transactional_opt_in": true,
      "email_transactional_opt_in": true,
      "whatsapp_marketing_opt_in": false,
      "email_marketing_opt_in": false,
      "external_reference_id": "CRM-12345",
      "external_reference_url": "https://crm.example.com/contacts/12345",
      "bankflip_user_link": null,
      "bankflip_documentation_area_id": null,
      "unattended": false,
      "unanswered_email": false,
      "unanswered_whatsapp": true,
      "unanswered_call": false,
      "on_task": true,
      "check_tasks_pending": false,
      "ignored": false,
      "is_client": false,
      "remove_requested": false,
      "last_close_won_reason": null,
      "last_close_lost_reason": null,
      "merged": false,
      "merged_at": null,
      "last_closed_office_message_sent_at": null,
      "last_assignee_at": "2024-08-15T14:30:00Z",
      "last_started_task_at": "2024-08-18T09:00:00Z",
      "last_completed_task_at": null,
      "last_successful_call_at": null,
      "last_unsuccessful_call_at": null,
      "last_email_sent_at": null,
      "last_email_received_at": null,
      "last_window_opened_at": "2024-08-19T17:20:00Z",
      "ai_controlling": false,
      "ai_disabled": false,
      "ai_test": false,
      "ai_suppressed_until_flow_step_change": false,
      "ai_reply_count_in_state": 0,
      "deals_count": 2,
      "meetings_count": 1,
      "pinned_comment_id": null,
      "has_skills": false,
      "skills": [],
      "created_at": "2024-08-15T14:30:00Z",
      "updated_at": "2024-08-19T17:20:00Z",
      "deleted_at": null,
      "locale": "en",
      "country_code": "US",
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_2024",
      "utm_term": null,
      "utm_content": null,
      "gclid": "Cj0KCQjw...",
      "landing_page_url": "https://example.com/landing",
      "landing_page_query": "?ref=google",
      "leadgen_id": null,
      "ad_id": null,
      "ad_name": null,
      "adgroup_id": null,
      "adgroup_name": null,
      "page_id": null,
      "page_name": null,
      "form_id": null,
      "deleted_phone": null,
      "deleted_email": null,
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "sent_imported_email_ids": [],
      "received_imported_email_ids": [],
      "custom_attributes": [
        {
          "id": "507f1f77bcf86cd799439012",
          "field_name": "budget",
          "humanized_name": "Budget",
          "field_type": "integer",
          "editable": true,
          "value": 50000,
          "string_value": null,
          "integer_value": 50000,
          "float_value": null,
          "date_value": null,
          "boolean_value": null,
          "array_value": null,
          "nullable": false
        }
      ]
    },
    "message": {
      "from": "1234567890",
      "id": "wamid.HBgNMTIzNDU2Nzg5MAAKMD==",
      "timestamp": "1724185200",
      "type": "text",
      "text": {
        "body": "Hello, I have a question about your services"
      }
    }
  },
  "timestamp": 1724185200
}

deal_created

Payload fields (19)
  • payload.dealobjectrequired
  • payload.deal.idstring
  • payload.deal.account_idstring
  • payload.deal.contact_idstring
  • payload.deal.assignee_idstringnullable
  • payload.deal.closer_idstringnullable
  • payload.deal.titlestringnullable
  • payload.deal.descriptionstringnullable
  • payload.deal.amountnumbernullable
  • payload.deal.close_datestring (date-time)nullable
  • payload.deal.closedboolean
  • payload.deal.wonboolean
  • payload.deal.statusstringnullable
  • payload.deal.external_reference_idstringnullable
  • payload.deal.deleted_external_reference_idstringnullable
  • payload.deal.deleted_crm_idstringnullable
  • payload.deal.created_atstring (date-time)
  • payload.deal.updated_atstring (date-time)
  • payload.deal.deleted_atstring (date-time)nullable
Example event
{
  "event": "deal_created",
  "source": "api",
  "payload": {
    "deal": {
      "id": "507f1f77bcf86cd799439044",
      "account_id": "507f191e810c19729de860ea",
      "contact_id": "507f1f77bcf86cd799439011",
      "assignee_id": "507f191e810c19729de860eb",
      "closer_id": null,
      "title": "Q3 Enterprise License",
      "description": "Annual enterprise software license renewal",
      "amount": 150000.5,
      "close_date": null,
      "closed": false,
      "won": false,
      "status": "open",
      "external_reference_id": "DEAL-2024-089",
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "created_at": "2024-08-01T10:00:00Z",
      "updated_at": "2024-08-01T10:00:00Z",
      "deleted_at": null
    }
  },
  "timestamp": 1722506400
}

deal_updated

Payload fields (21)
  • payload.dealobjectrequired
  • payload.deal.idstring
  • payload.deal.account_idstring
  • payload.deal.contact_idstring
  • payload.deal.assignee_idstringnullable
  • payload.deal.closer_idstringnullable
  • payload.deal.titlestringnullable
  • payload.deal.descriptionstringnullable
  • payload.deal.amountnumbernullable
  • payload.deal.close_datestring (date-time)nullable
  • payload.deal.closedboolean
  • payload.deal.wonboolean
  • payload.deal.statusstringnullable
  • payload.deal.external_reference_idstringnullable
  • payload.deal.deleted_external_reference_idstringnullable
  • payload.deal.deleted_crm_idstringnullable
  • payload.deal.created_atstring (date-time)
  • payload.deal.updated_atstring (date-time)
  • payload.deal.deleted_atstring (date-time)nullable
  • payload.actionstring
    Present only when the update has a known cause. won, lost, reopened: the deal was won, lost or reopened through the dedicated win/lose/reopen operation. Status changes made through a generic deal update carry no action.
    Values:wonlostreopened
  • payload.changesobject
    Present only together with action. Maps the fields tied to the action to [previous, new]. won, lost and reopened contain only status (closed, won and close_date are not listed); previous equals new when the operation is re-applied to a deal already in that status.
Example event
{
  "event": "deal_updated",
  "source": "user",
  "payload": {
    "deal": {
      "id": "507f1f77bcf86cd799439044",
      "account_id": "507f191e810c19729de860ea",
      "contact_id": "507f1f77bcf86cd799439011",
      "assignee_id": "507f191e810c19729de860eb",
      "closer_id": null,
      "title": "Q3 Enterprise License",
      "description": "Annual enterprise software license renewal",
      "amount": 150000.5,
      "close_date": null,
      "closed": false,
      "won": false,
      "status": "open",
      "external_reference_id": "DEAL-2024-089",
      "deleted_external_reference_id": null,
      "deleted_crm_id": null,
      "created_at": "2024-08-01T10:00:00Z",
      "updated_at": "2024-08-19T18:30:00Z",
      "deleted_at": null
    },
    "action": "reopened",
    "changes": {
      "status": [
        "lost",
        "open"
      ]
    }
  },
  "timestamp": 1724188200
}

task_completed

Payload fields (25)
  • payload.taskobjectrequired
  • payload.task.identifierstringnullable
  • payload.task.started_atstring (date-time)nullable
  • payload.task.completed_atstring (date-time)nullable
  • payload.task.time_spentintegernullable
  • payload.task.attemptsintegernullable
  • payload.task.active_onstring (date)nullable
  • payload.task.finish_statusstringnullable
  • payload.task.subject_idstringnullable
  • payload.task.assignee_idstringnullable
  • payload.task.playbook_idstringnullable
  • payload.task.callsarray<object>
  • payload.task.calls[]._idstring
  • payload.task.calls[].tostring
  • payload.task.calls[].fromstring
  • payload.task.calls[].started_atstring (date-time)nullable
  • payload.task.calls[].completed_atstring (date-time)nullable
  • payload.task.calls[].incoming_callbooleannullable
  • payload.task.calls[].durationintegernullable
  • payload.task.calls[].response_statusstringnullable
  • payload.task.calls[].statusstringnullable
  • payload.task.calls[].user_idstringnullable
  • payload.task.subjectobject
  • payload.task.subject._idstring
  • payload.task.subject.external_reference_idstringnullable
Example event
{
  "event": "task_completed",
  "source": "user",
  "payload": {
    "task": {
      "identifier": "TASK-20240819-001",
      "started_at": "2024-08-19T09:00:00Z",
      "completed_at": "2024-08-19T09:15:30Z",
      "time_spent": 930,
      "attempts": 2,
      "active_on": "2024-08-19",
      "finish_status": "completed",
      "subject_id": "507f1f77bcf86cd799439011",
      "assignee_id": "507f191e810c19729de860eb",
      "playbook_id": "507f191e810c19729de860ec",
      "calls": [
        {
          "_id": "507f1f77bcf86cd799439055",
          "to": "+1234567890",
          "from": "+0987654321",
          "started_at": "2024-08-19T09:00:00Z",
          "completed_at": "2024-08-19T09:15:30Z",
          "incoming_call": false,
          "duration": 930,
          "response_status": "completed",
          "status": "completed",
          "user_id": "507f191e810c19729de860eb"
        }
      ],
      "subject": {
        "_id": "507f1f77bcf86cd799439011",
        "external_reference_id": "CRM-12345"
      }
    }
  },
  "timestamp": 1724190000
}

incoming_call

Payload fields (3)
  • payload.fromstringrequired
  • payload.tostringrequired
  • payload.forwarded_fromstringnullable
Example event
{
  "event": "incoming_call",
  "source": "unknown",
  "payload": {
    "from": "+1234567890",
    "to": "+0987654321",
    "forwarded_from": null
  },
  "timestamp": 1724192000
}

submitted_form_created

Payload fields (34)
  • payload.submitted_formobjectrequired
  • payload.submitted_form.idstring
    Unique submitted form identifier
  • payload.submitted_form.account_idstring
    Account this submitted form belongs to
  • payload.submitted_form.contact_idstringnullable
    Contact created or matched from this form submission
  • payload.submitted_form.form_idstringnullable
    ID of the source form (Typeform, Meta Lead Ad, TikTok Instant Form, or web form)
  • payload.submitted_form.form_namestringnullable
  • payload.submitted_form.sourcestringnullable
    Where the form was submitted from
    Values:webmetatypeformtiktok
  • payload.submitted_form.field_errorsarray<string>
    Validation or mapping errors encountered while processing this submission
  • payload.submitted_form.typeform_responseobjectnullable
    Raw Typeform webhook payload, documented as-is (not sanitized)
  • payload.submitted_form.meta_responseobjectnullable
    Raw Meta Lead Ads API response, documented as-is (not sanitized)
  • payload.submitted_form.meta_webhook_changeobjectnullable
    Raw Meta webhook change payload, documented as-is (not sanitized)
  • payload.submitted_form.web_responseobjectnullable
    Raw web form submission payload, documented as-is (not sanitized)
  • payload.submitted_form.tiktok_responseobjectnullable
    Raw TikTok lead webhook entry: answers in changes, plus the lead, campaign, ad group and ad IDs and names. Documented as-is (not sanitized)
  • payload.submitted_form.meta_leadgen_idstringnullable
    Meta Lead Generation form ID
  • payload.submitted_form.meta_page_idstringnullable
    Facebook/Meta page ID
  • payload.submitted_form.meta_page_namestringnullable
  • payload.submitted_form.meta_ad_idstringnullable
    Facebook/Meta ad ID
  • payload.submitted_form.meta_ad_namestringnullable
  • payload.submitted_form.meta_adgroup_idstringnullable
  • payload.submitted_form.meta_adgroup_namestringnullable
  • payload.submitted_form.created_atstring (date-time)
  • payload.submitted_form.updated_atstring (date-time)
  • payload.submitted_form.responsesarray<SubmittedFormResponse>
  • payload.submitted_form.responses[].idstring
    Unique identifier of this response
  • payload.submitted_form.responses[].labelstringnullable
    Human-readable label of the form field
  • payload.submitted_form.responses[].input_idstringnullable
    Identifier of the field on the source form
  • payload.submitted_form.responses[].field_string_valuestringnullable
  • payload.submitted_form.responses[].field_number_valueintegernullable
  • payload.submitted_form.responses[].field_float_valuenumbernullable
  • payload.submitted_form.responses[].field_date_valuestring (date)nullable
  • payload.submitted_form.responses[].field_date_time_valuestring (date-time)nullable
  • payload.submitted_form.responses[].field_time_valuestring (date-time)nullable
  • payload.submitted_form.responses[].field_boolean_valuebooleannullable
  • payload.submitted_form.responses[].field_string_valuesarray<string>nullable
    Populated when the field allows multiple values (e.g., checkboxes)
Example event
{
  "event": "submitted_form_created",
  "source": "unknown",
  "payload": {
    "submitted_form": {
      "id": "507f1f77bcf86cd799439066",
      "account_id": "507f191e810c19729de860ea",
      "contact_id": "507f1f77bcf86cd799439011",
      "form_id": "120210000000000",
      "form_name": "Get a free quote",
      "source": "meta",
      "field_errors": [],
      "typeform_response": null,
      "meta_response": null,
      "meta_webhook_change": {
        "field": "leadgen",
        "value": {
          "leadgen_id": "120210000000001",
          "page_id": "987654321012345",
          "ad_id": "120210000000002",
          "adgroup_id": "120210000000003",
          "form_id": "120210000000000"
        }
      },
      "web_response": null,
      "meta_leadgen_id": "120210000000001",
      "meta_page_id": "987654321012345",
      "meta_page_name": "Acme Corp",
      "meta_ad_id": "120210000000002",
      "meta_ad_name": "Summer promo",
      "meta_adgroup_id": "120210000000003",
      "meta_adgroup_name": "Summer campaign",
      "created_at": "2024-08-19T18:00:00Z",
      "updated_at": "2024-08-19T18:00:00Z",
      "responses": [
        {
          "id": "507f1f77bcf86cd799439077",
          "label": "What is your budget?",
          "input_id": "question_budget",
          "field_string_value": null,
          "field_number_value": 50000,
          "field_float_value": null,
          "field_date_value": null,
          "field_date_time_value": null,
          "field_time_value": null,
          "field_boolean_value": null,
          "field_string_values": null
        }
      ]
    }
  },
  "timestamp": 1724192500
}