Mav’s outbound API consists of subscribing to either event or outcome activity. Activity subscriptions are optional. You can choose to subscribe to one, many or all of the available activities (events and outcomes) your playbook supports.
Mav’s outbound API consists of subscribing to either event or outcome activity via webhook URL.
Activity subscriptions are optional. You can choose to subscribe to one, many or all of the available activities (events and outcomes) your playbook supports.
Event activities are available across all playbooks and they include the following:
- started — when Mav sends out the first message to the lead
- double_opted_in — when a lead expresses positive intent and opts-in
- interested — when a lead expresses positive intent. Note: this is usually called at the same time as double_opted_in.
- stopped — when a playbook is stopped (either manually or during an opt-out)
- completed — when a playbook has reached an outcome
- reengagement_sent — when Mav sends a smart re-engagement to a lead
- party_line_lead_attempted — when Mav attempts to call the lead for a party line
- party_line_lead_unsuccessful — when a lead doesn't confirm they would like to be connected
- party_line_lead_answered — when the lead confirms they would like to be connected to the Rep
- party_line_rep_attempted — when Mav attempts to call the rep for a party line
- party_line_rep_unsuccessful — when Mav is unable to join the lead and rep for a party line
- party_line_lead_initiated_call - when a lead calls into your Mav number
- party_line_lead_initiated_call_unsuccessful — when a lead doesn't confirm they would like to be connected
- catch_all_level1 — when a lead hits CatchAll Level 1
- catch_all_level2 — when a lead hits CatchAll Level 2
- catch_all_level3 — when a lead hits CatchAll Level 3
- copilot_paused — when a lead requires an Mav operator to intervene
- copilot_restarted — when a Mav operator has restarted the conversation
Outcome activities are specific to your playbook. To give you an example, a typical Mortgage qualification playbook will include these outcomes that are available for you to subscribe to:
- callback_requested — when the lead has requested a call back
- party_line_completed — when the lead and the rep have successfully created a party line
- qualified — when the lead is qualified
- unqualified — when the lead is unqualified
- opted_out — when the lead opts out of messaging
Both events and outcomes will post a similar parameters to your supplied URL endpoint and you can expect to see the following parameters for each:
- activity_type — event or outcome
- activity_label — name of event or outcome
- activity_play_id — Mav ID of the this specific play
- activity_note — summary of activity
- activity_created_at — timestamp of activity
- lead_id — Mav lead ID
- lead_first_name — lead first name
- lead_last_name — lead last name
- lead_email — lead email
- lead_opted_out — opt out status
- lead_created_at — timestamp creation date for lead
- lead_additional_info — array of additional information that is specific to your playbook.
- lead_originators
- origin — source name
- key — unique ID of originator source
Note: lead_orginators can be the same data you passed on the inbound call. This can be used to match a lead in your system and update the record.