What is a Delivery?
A Delivery is where leads are individually sent from your LeadByte Campaign to another party. This other party may be a Buyers remote system, your dialler or even another LeadByte campaign within your own account. Using the options described below you are able to fine tune which leads go to which Delivery and how/where they are sent.
Under the Manage Deliveries tab you are given an overview of all Active, Inactive and Saved Deliveries. You also create new campaigns from this page. A Delivery will remain under the saved tab until you have successfully tested it. Once this has been completed, it will move from Saved to Inactive where you can enable it when ready.
Add New Delivery/Edit Delivery
This is what your delivery will be called on reports or when searching the system
When lead arrives (automatic)
Deliver a lead when it enters your campaign and matches the criteria / rules of the delivery.
Manually / via code
To trigger a Lead via the REST API, you will need to generate an API key which you can do under ADMIN>REST API. On this page, you will be given implementation notes to get you up and running. Each Delivery has it's own Delivery ID, which is used to trigger your Lead forwarding. More on this can be found here.
Select the campaign that you want to link this delivery to. You can link multiple deliveries to a campaign.
This is the method for delivering the lead. Your options are:
2 Step Authentication
If your clients remote system needs you to make an authentication call to gather a token before submitting the lead data, you will need to use this method.
Post a lead to one of your internal LeadByte Campaigns.
This could be a CRM, Dialler, ESP to name a few. This is the most commonly used Action.
Send leads to a given email address as soon as they arrive.
Enables you to Ping your Buyers API with partial lead data and based on the response, create rules on whether or not you wish to Post the full lead data to your Buyer.
Use this option if you only want to assign a lead to a buyer. This can be based on rules e.g. must be 18+ and live in a specific postcode area.
Send lead information directly to a given mobile number.
When you want to deliver leads to another system, you have the option to select the remote system / method (i.e. JSON, XML, POST/GET). It's always worth looking through this list to see if we've created a custom integration for the system you're trying to deliver to (eg SalesForce or Connex). Reach out to us with any questions on these integrations. If you are delivering to another system ask your point of contact for an integration guide (this should be provided). (PLEASE NOTE THAT THIS IS ONLY AVALIABLE ONCE THE DIRECT POST ACTION HAS BEEN SELECTED)
Enter in the URL that you are posting the lead to.
The MD5 hash function produces a hash value for the data (or string) that you send to the remote system. In the world of Lead Generation, it is commonly used to verify data integrity. By enabling this option, you will see that an additional field mapping is created. You have the option to confirm which fields to hash. (PLEASE NOTE THAT THIS IS ONLY AVALIABLE ONCE THE DIRECT POST ACTION HAS BEEN SELECTED)
Advanced Distribution only
By ticking this option, the created Delivery will only run if it is part of an Advanced Distribution setup within the selected Campaign. This can be managed under Campaigns>Settings>Advanced Distribution.
This will enable you to set the Delivery to active without worrying about leads being Delivered until you add it to your Advanced Distribution schedule.
More on Advanced Distribution here.
If you select 5pm-8am any leads received between these times will not be delivered until 8am. The delivery is paused, leads are queue until 8am (in the example). (CANNOT BE USED WHEN ADVANCED DISTRIBUTION ONLY IS TICKED)
Buyers & Financials
If you are delivering leads to a Buyer (client) you will need to select the Buyer here. This is important if you want to track which buyer the lead has been assigned to and the revenue. You have three options for associating Revenue
Revenue on accept
This is the most common. The revenue amount will be assigned when the delivery is successfully triggered. If the lead is being delivered to a remote system, it will be if the remote system responds with the success code.
This would only be used when delivering to a remote system. If you Buyer will respond with a revenue value, this can be captured and stored.
IF you want to associate revenue against a lead based on specific data, this option would be used. For example, you may get paid 10.00 if the lead is Female and 5.00 if the lead is male (defined off the Gender field). You can also set the
If you want to associate revenue against a lead based on specific data, this option would be used. In the below example, the Buyer will pay $15.00 for leads that have "Facebook" as a Source. If the Source does not match this value, the fallback amount the Buyer will pay for the lead will be $10.00.
Please note that you can also set a different Supplier Payout based on the Rule Based Revenue on the Buyer Delivery.
Use caps if you want to restrict the number of leads that should be delivered. For example, you may have an agreement with your Buyer that they only want 5 p/day with a total order value of 100. You would enter 100 in the Total caps box and 5 in the Daily caps box. For further info on Delivery Caps please click here.
Custom Data Mappings
This defines WHAT you want to deliver i.e. Name, Email, Telephone and in what format i.e. UPPERCASE, Telephone in International Format. In the case where you are delivering leads to a remote system it is the OUTPUT FIELD which determines the name of the field. For example, if a client wanted Email to be "Email_Address", Email_Address would be entered into the output field. Under "Options", you have the opportunity to translate the data. An example of this would be making Last Name UPPERCASE or making Telephone number in International format.
Add New Mapping
This will enable you to add a new mapping.
This is your campaign field you want to deliver.
This is the name of the field you want to deliver to the client
Anything which is in this field will be posted out with each delivery. For example, it may be a password/key or an additional field that you do not collect on the campaign such as a broker code that the remote system has assigned to you.
Sample values are used for testing purposes. Standard fields are populated for you however, you will need to enter in sample values for any additional fields or field mappings you create
Advanced options for each mapping. Here you can translate values, set a format (eg DD/MM/YYYY needs to be posted out as YYYY-MM-DD) or make Last Name UPPERCASE. Further example here.
This section allows you to alter the scheduling of your lead delivery. You can delay the delivery of leads coming into your campaign by anywhere between 10 minutes and 1 week.
Please note this will not work if your delivery is part of Advanced Distribution.
Rule determine if a delivery should be triggered. For example, if your Buyer only wants leads within a specific postcode / zipcode range you would create a rule for this. You can read more about rules here
Remote System Response
Here you should enter the responses from the remote system (both success and reject messages). These responses can be taken from an integration guide you receive from your remote system. In some cases a remote system will send back multiple success codes. You can mark more than one response as success in the system as shown in the example screenshot below.
TIP - be sure that if you use keyword that the word used in a success response code is not used in an unsuccessful response code (it happens a lot)
Trigger SMS/Email when Delivery successful
Let's say you deliver HIGH VALUE leads to your Buyer's CRM but they want to be sure that they are "on it". You have the option to send an email and/OR SMS when the lead has been successfully delivered. See image below. Remember, this is a billable service.
On Success, Trigger Delivery
Let's say you want to document all of the leads that are sold to your own CRM/BI for reporting purposes. This is a handy tool where you can trigger another Delivery to send the lead information to another endpoint if the parent Delivery is successful. Please note that you can only trigger REST API Deliveries. (Trigger Type will need to be set to Manually/ via code).
On Failure, Trigger Delivery
Let's say you want to do the same as the above, but only want to document leads that are unsold. This option will trigger another Delivery to send the lead information to another endpoint if the parent Delivery has failed. Please note that you can only trigger REST API Deliveries. (Trigger Type will need to be set to Manually/ via code).
Some remote systems require certain fields to be posted out in the header of a message. The screenshot below shows an example where the remote system needing an API key to be posted in the header.
SSL cipher list
A cipher code may be required if the remote system you are posting to uses cipher suites as a security protocol on their network. When testing, you would likely see the error message "Cannot communicate securely with peer: no common encryption algorithm(s)" if cipher suite is installed and you have not entered in the value. The client should provide this. You can use this site to see if the system you are posting to uses Cipher suite: https://www.ssllabs.com/ssltest/ and obtain the cipher suite being used. From this, you can obtain the cipher value on this site: https://unix.stackexchange.com/questions/208437/how-to-convert-ssl-ciphers-to-curl-format
The remainder of the settings are for advanced users but feel free to reach out to us if you have any questions
In order to set move a delivery from Saved to Inactive you'll need to send a test delivery to make sure it's working. This prevents you from enabling a delivery which doesn't work! The test lead sent contains the sample values from the mappings section detailed above
This is relevant if your delivery is Email or SMS (including sending an email/SMS on successful delivery to a remote system). See the image below, It illustrates how to customise an email delivery using tags.