Data Contactability
1 -
Data Contactability
Add Choice
Installing a custom flow step requires Admin permissions in Marketo. Apart from the Installation URL, all other aspects of a serviced may be edited after completing initial onboarding by drilling down into the service detail screen from the Service Providers grid.
In Marketo navigate to Admin → Service Providers and click Add New Service
From here, follow the bellow steps to install and configure the flow step.
Flow Step Service
Confirm installation
To begin installation, you’ll need to first enter the install URL of the Data Contactability flow step shown above. This URL gives Marketo the basic information it needs to connect to and configure the flow step.
Flow Step Service
Enter Credentials
Please provide an API Key. Valid API credentials from Flowsteps.io are required to complete installation.
After you enter the installation URL you will be asked to enter your API Key. When you save your credentials, Marketo will attempt to verify that it is valid. If the credentials provided are invalid, you’ll see an error indicating this.
Flow Step Service
Map Outgoing Fields
Map Incoming Fields
Approve Contexts & Finish
Flowsteps.io has provided a list of required and optional fields to map to Marketo Lead fields. Fields which are mapped and active will be sent to the service provider when Data Contactability is invoked from a Smart Campaign. Required mappings must be completed and be active in order to complete service installation.
| Active | External Field | Type | Description | Marketo Field |
|---|---|---|---|---|
|
|
Address | text | Address |
Address
|
|
|
Country | string | Country |
Country
|
|
|
PostalCode | string | PostalCode |
PostalCode
|
|
|
Email
|
|||
|
|
blackListed | boolean | blackListed |
blackListed
|
|
|
EmailInvalid | boolean | EmailInvalid |
EmailInvalid
|
|
|
emailSuspended | boolean | emailSuspended |
emailSuspended
|
|
|
marketingSuspended | boolean | marketingSuspended |
marketingSuspended
|
|
|
Unsubscribed | boolean | Unsubscribed |
Unsubscribed
|
|
|
zbStatus | string | ZB Status check as valid these values ['valid','catch-all'] coming from Zerobounce ssfs |
zbStatus
|
|
|
MobilePhone | string | MobilePhone |
MobilePhone
|
|
|
MobileValidationStatus | string | MobileValidationStatus considers as a right value if it's not an invalid value, this normally comes from Twilio Phone Validation SSFS |
mobileValidationStatus
|
|
|
Phone | string | Phone |
Phone
|
|
|
PhoneValidationStatus | string | PhoneValidationStatus considers as a right value if it's not an invalid value, this normally comes from Twilio Phone Validation SSFS |
phoneValidationStatus
|
The Outgoing Fields, are sent to the Data Contactability flow step. Be sure to activate and map all required fields.
After you enter the installation URL you will be asked to enter your API Key. When you save your credentials, Marketo will attempt to verify that it is valid. If the credentials provided are invalid, you’ll see an error indicating this.
Flow Step Service
Map Outgoing Fields
Map Incoming Fields
Approve Contexts & Finish
Flowsteps.io has provided a list of response mappings to map to Marketo Lead fields. Fields which are mapped and active may be written to by Flowsteps.io, when processing of Data Contactability is complete. Response Mappings are not required to complete service installation, but the service may not function as expected if mappings are not provided.
| Active | External Field | Type | Description | Marketo Field |
|---|---|---|---|---|
|
|
ContactibilityScore | integer | Percentage of available contact methods (email, phone, address, mobile) |
ContactibilityScore
|
|
|
ContactabilityDetails | text | Any additional message could be here |
ContactabilityDetails
|
The Data Contactability flow step uses set inbound fields. Below are the fields that are returned from the flow step and can be written to the person based on the mapping you set.
Flow Step Service
Map Outgoing Fields
Map Incoming Fields
Approve Contexts & Finish
Flowsteps.io is requesting access to the following data contexts. When Data Contactability is invoked from a Smart Campaign, the data from these objects will be sent as contextual information to Flowsteps.io, such that processing may be completed.
Subscription
Program
Program Member
Smart Campaign
Trigger
My Tokens
Finally review the context data that will be sent to the to Data Contactability flow step, and approve.
Outbound Fields
The Data Contactability flow step uses set outbound fields. Below are the person fields that are sent to the flow step based on the mapping you set.
| Name | API Name | Type | Description |
|---|---|---|---|
| Address | Address | text | Address |
| Country | Country | string | Country |
| PostalCode | PostalCode | string | PostalCode |
| BlackListed | blackListed | boolean | blackListed |
| EmailInvalid | EmailInvalid | boolean | EmailInvalid |
| EmailSuspended | emailSuspended | boolean | emailSuspended |
| MarketingSuspended | marketingSuspended | boolean | marketingSuspended |
| Unsubscribed | Unsubscribed | boolean | Unsubscribed |
| zbStatus | zbStatus | string | ZB Status check as valid these values ['valid','catch-all'] coming from Zerobounce ssfs |
| MobilePhone | MobilePhone | string | MobilePhone |
| MobileValidationStatus | MobileValidationStatus | string | MobileValidationStatus considers as a right value if it's not an invalid value, this normally comes from Twilio Phone Validation SSFS |
| Phone | Phone | string | Phone |
| PhoneValidationStatus | PhoneValidationStatus | string | PhoneValidationStatus considers as a right value if it's not an invalid value, this normally comes from Twilio Phone Validation SSFS |
Inbound Fields
The Data Contactability flow step uses set inbound fields. Below are the fields that are returned from the flow step and can be written to the person based on the mapping you set.
| Name | Suggested Marketo Field | Description |
|---|---|---|
| ContactibilityScore | ContactibilityScore | Percentage of available contact methods (email, phone, address, mobile) |
| ContactabilityDetails | ContactabilityDetails | Any additional message could be here |
Global Configuration Fields
Global user inputs that are passed along with every call to the Data Contactability flow step service. Global attributes can be set during installation or updated from the Service Provider admin menu.
Flow Step Fields
These fields are set for each individual instance of the Data Contactability flow step and are sent per-lead when it is called.
| Name | API Name | Type | Description |
|---|---|---|---|
| Contactability Score is Requested | ssfsinput | boolean | Contactability Score is Requested |
Context Data
| Name | Description |
|---|---|
| Program Context | Data about the program where the flow step was triggered including name, id, type, workspace etc. |
| Campaign Context | Data about the campaign where the flow step was triggered, including name, id, type, status, etc. |
| Trigger Context | Context around the trigger that initiated the smart campaign where the flow step was called. No data is sent if the flow step was called in a batch campaign. |
| Subscription Context | General data about the subscription including munchkinId and name |
Flow Step
Once the Data Contactability flow step is installed it becomes available in smart campaigns.
1 -
Data Contactability
Add Choice
Trigger & Filter
Once the Data Contactability flow step is in use the activity can be used as a trigger or a filter inside smart lists and smart campaigns.
Contactability Score is Requested
1 - Contactability Score was Requested