all repos are potentially using BBMS to send email

BBMS_EMAIL.md

birchbox:

• event config
• sendUserUpdateToBBMS | payload

{
  "email": "",
  "customerId": "",
  "region": "",
  "event": "update_user",
  "keys":[
    {"email": ""}
  ]
}

• sendAbandonedCartEventToBBMS | payload

[
  {
    "email": "",
    "incomplete": 1,
    "items": [],
    "reminder_time_minutes": "",
    "reminder_template": "",
    "event": "abandoned_cart",
    "customer_id": "",
    "region": ""
  }
]

• sendPurchaseEventToBBMS | payload

{
  "email": "",
  "items": [],
  "message": "sailthru_bid or null",
  "event": "purchase",
  "region": "",
  "coupon_code": ""
}

• sendBreakageFixToBBMS | payload

{
  "email": "",
  "customerId": "",
  "region": "",
  "provider": "",
  "template": "M_Breakage_Fix/W_Breakage_Fix",
  "message": "M_BREAKAGE_FIX/W_BREAKAGE_FIX",
  "vars": {
    "first_name": ""
  }
}

• sendBreakageEmails | payload

{
 "email": "",
 "customerId": "",
 "region": "",
 "provider": "",
 "template": "M_Breakage_Cancel_Notice/W_Breakage_Cancel_Notice",
 "message": "M_Breakage_Cancel_Notice/W_Breakage_Cancel_Notice",
 "vars": {
   "first_name": ""
 }
}

• sendVIPNotifications | payload

{
  "email": "",
  "customerId": "",
  "region": "",
  "provider": "",
  "template": "VIP_WELCOME_TEMPLATE/VIP_RENEW_TEMPLATE",
  "message": "VIP_WELCOME_MESSAGE/VIP_RENEW_MESSAGE",
  "since": "",
  "vars": {}
}

• sendGiftExpirationEmails | payload

{
  "email": "",
  "customerId": "",
  "region": "",
  "provider": "",
  "template": "W_S_GiftExpirationNotice/W_NS_GiftExpiration/M_S_GiftExpirationNotice/M_S_GiftExpiration",
  "message": "GIFT_EXPIRE",
  "since": "",
  "vars": {}
}

warehouse_etl:

• fetch data files from bbms
• config

email_integrations:

• config

• payload:

  • process_rebillable_upgrade_emails_success_thru_bbms

  {
    "message": "REPLENISHMENT_BILLING_SUCCESS/UPGRADE_BILLING_SUCCESS",
    "email": "",
    "customerId": "",
    "region": "",
    "template": "602eefab-5920-4a23-b459-421bc407c792/faa62ca6-c736-4538-8816-49827ac83d39",
    "provider": "sendgrid",
    "since": "",
    "until": "",
    "vars":{
      "rebilling_date": "",
      "ship_month": "",
      "ship_date": "",
      "name": "customer name",
      "full_name": "",
      "street": "",
      "city": "",
      "state": "",
      "zip": "",
      "subtotal": "",
      "taxtotal": "",
      "total": "",
      "tax_rate": "",
      "products": "",
      "products_HTML": "",
      "additionaltotals_HTML": "",
      "subject": "customer ship month"
    }
  }

  • process_rebillable_upgrade_emails_breakage_thru_bbms

  {
    "message": "REPLENISHMENT_BILLING_FAILURE/UPGRADE_BILLING_FAILED",
    "email": "",
    "customerId": "",
    "region": "",
    "template": "810f87dc-4937-4e6d-a6eb-ca141d9b93ea/c556b448-cb11-452b-9c2a-d66f683bdb1d",
    "provider": "sendgrid",
    "since": "",
    "until": "",
    "vars":{
      "failure_block": ""
    }
  }

  • process_upgrade_confirmation_emails_thru_bbms

    {
      "message": "UPGRADE_ORDER_CONFIRMATION",
      "email": "",
      "customerId": "",
      "region": "",
      "template": "bed94997-f4cb-4169-ad10-43aa48e6cc4e",
      "provider": "sendgrid",
      "since": "",
      "until": "",
      "vars":{
        "vertical_identifier": "",
        "cycle_end": "",
        "ship_month": "",
        "rebilling_date": "",
        "name": "",
        "subtotal": "",
        "tax_total": "",
        "total": "",
        "products": "",
        "products_HTML": "",
        "additionaltotals_HTML": ""
      }
    }

intech_reports:

• send refund email

  {
    "message": "RETURN_MESSAGE",
    "email": "",
    "customerId": "",
    "region": "",
    "template": "CS_G_S_Refund_Only",
    "vars": {
      "first_name": ""
    },
    "provider": "should be NONE",
    "since": "",
    "until": ""
  }

• send return email

  {
    "message": "RETURN_MESSAGE",
    "email": "",
    "customerId": "",
    "region": "",
    "template": "CS_G_S_Return_Confirmation",
    "vars": {
      "label_url": "",
      "order_number": "",
      "first_name": ""
    },
    "provider": "should be NONE",
    "since": "",
    "until": ""
  }

• send sample choice email

    {
      "message": "SAMPLE_CHOICE",
      "email": "",
      "customerId": "",
      "region": "",
      "template": "CS_G_S_SampleChoice_Confirmation",
      "vars": {
        "display_name": ""
      },
      "provider": "should be NONE",
      "since": "",
      "until": ""
    }

• send ng return email email

  {
    "message": "CS_G_A_FZ_ReturnProcessed",
    "email": "",
    "customerId": "",
    "region": "",
    "template": "CS_G_A_FZ_ReturnProcessed",
    "vars": {
    },
    "provider": "should be NONE",
    "since": "",
    "until": ""
  }

• send message through bbms
  • email payload
  • queue name

subscription_api:

• subscription pause confirmation

{
   "customerId": "",
   "email":  "",
   "message": "CS_G_S_SubscriptionPause_Confirmation",
   "provider": "selligent",
   "region": "US",
   "template": "",
   "vars": {
     "first_name": "",
     "month": "",
     "next_month": "",
     "rebilling_day": "",
     "deadline_date": ""
   }
}

• subscription unpause confirmation email

 {
    "customerId": "",
    "email":  "",
    "message": "CS_G_S_SubscriptionUnpause_Confirmation",
    "provider": "selligent",
    "region": "US",
    "template": "",
    "vars": {
      "first_name": "",
      "month": "",
      "rebilling_day": "",
      "deadline_date": ""
    }
 }

• UK failed payment might trigger email send out
  • commented out usage
  • payload

   {
      "customerId": "",
      "email":  "",
      "message": "CS_G_S_BrokenSubscription",
      "provider": "selligent",
      "region": "UK",
      "template": "",
      "vars": {
      }
   }

user_api:

• oms event payload in vertical question update func:

{
  "data":{
    "entity_id": "$current_customer_id"
  },
  "type": "customer",
  "region": "us"
}

• config

shapi:

• selligent ftp import

DME:

• event payload

{
  "customerId": "$customer_id",
  "email": "",
  "countryCode": "",
  "trackingNumber": "",
  "trackingUrl": "",
  "subscriptionVertical": "womens/men",
  "shippingCycleId": "",
  "shopId": ""
}

• reship payload

{
  "message": "RESHIP",
  "template": "CS_G_S_Reship_Confirmation",
  "email": "",
  "customerId": "",
  "region": "$country_code",
  "vars": {
    "tracking_number": "",
    "product_name": "",
    "tracking_url": "",
    "shipping_carrier": "",
  }
}

• config

bbop-orders:

• send triggered email payload

{
  "email":"",
  "customerId": "",
  "template": "GS_G_*****",
  "message": "",
  "vars":{
    "firstName": "",
    "productName": "",
    "promoCode": ""
  },
  "region": "",
  "provider": "selligent"
}

forms_api:

has bbms_path configured but not used in any func. See search result