Export Profiles are used to send data to a Postback URL or FTP or CSV. This article walks you through the configuration for an Export Webhook sending data to a Postback URL.
Generally these are used to send partials to a call center, but they are not limited to that function. We will add the field mappings you configure to the Postback URL string so the URL field will be just the URL itself without a string. Setting the mappings allow you to choose which CRM data matches your 3rd party data.
By default all webhooks are sent as a GET. Read Step 5 for how to send a POST.
Please note that Test Card orders will not export through the webhook system. |
Step 1: Go to ADMIN | EXPORTS page by using the main navigation.
Step 2: Create a New Export Profile by clicking the green + button.
Next, Enter your profile name and select Postback as the export type
Click create and the profile will be added to your Export Profile List.
Step 3: Configure the Postback Export
First, click edit to enter the profile configuration page:
This will take you to a page with two sections: General Settings and Field Mappings.
Step 4: Configure General Settings
Field Definitions:
Profile Name – The name of the export profile. Can be whatever you want.
Export Type – Type of Postback export
Postback URL – Where you want the information sent
Export Delay – Set the time, in minutes, for how how long the export should be delayed. By default the webhook service runs every 15 minutes and will fire any webhooks triggered since the last time it ran. If you add 5 minutes to the delay, this adds 5 minutes to the 15 minute default which will then result in the webhook task running every 20 minutes.
PCI Documentation is only required if the export will contain sensitive data. Please contact your account manager for assistance if necessary.
Step 5: Configure Field Mappings
First, click the green + button to add a Field Map
This will bring up a dialog box for adding a new field mapping. Field mappings essentially tell the system how to build the export file, which columns should be included and in what order.
Definitions:
Export Name: The name of the column in the CSV file.
Field: The name of the field you are mapping from the CRM order record.
Static Value: If selecting “Static” as the field, then this represents the static (unchanging) value that is always used.
Please view our available Field Mappings here!
Examples:
Mapping customer first name:
Mapping date created:
Mapping static value (ie, username/password, list_id, function, etc)
After you configure your mappings you will see them all listed. This is the data that will be sent any time this export profile is triggered:
Using https://postingmydata.com/partials.php as the Postback URL and the above field mappings, the webhook will send the data like this:
https://postingmydata.com/partials.php?first_name=[firstName]&order_date=[orderDate]&list_id=400&email_address=[emailAddress]&campaign_number=[campaignId]
The CRM will fill in the [field_mappings] with the data from the order records that get exported.
A webhook can be sent as a POST by entering headers as static fields. Enter Export Name “header:” followed by the header name and Value as the header value. This screenshot shows an example. The non-header field mappings are sent in the message body.
If header Content-Type (case-insensitive) is application/json then the field mappings are put into json format in the message body. Any other Content-Type sends query parameters in the body.
Step 6. Configure Profile Routing
Now that you have your Profile setup and your fields mapped. It's time to setup which campaigns and products should be included in the export. Without a routing setup, the system does not know if you intend to export partials, sales, cancellations or which campaigns you want to export data from.
First, Update to save any changes then click on Export Profiles on the top bar navigate back to the main Export Profile page.
This will take you back to the page we visited in Step 1. On the right side of this page you'll see a section titled Profile Routing. Click the green + button to add a new route.
This will bring up a dialogue:
Use the select boxes to determine which customer type, campaigns and products should be included in the export. You can select from the following customer types:
Partial – export only incomplete orders (also called leads)
New Sale – export only new sales that successfully billed
Upsell – export only orders that include an upsell
Subscription Started - export only new sales that include a recurring product
Pre-Billing – export only after prebill notification email has been sent prior to next rebill.
Recurring Order – export orders created as part of a continuity subscription
Decline – export orders that declined
Rebill Decline – export only when a rebill (recurring purchase) declines.
Recycle Failed – exports orders who reach recycle failed status
Cancel – exports if a recurring purchase is cancelled
Pause - when a recurring purchase is paused
Reactivate - when a recurring purchase is reactivated
All refunds - export orders that have been refunded
Partial refunds - export orders that have been partially refunded
Full refunds - export orders that have been fully refunded
Chargeback– export orders that has been chargedback
Fulfillment Shipped – exports orders when their fulfillment status shows as Shipped
Fulfillment delivered - exports orders when their fulfillment status shows as Delivered
RMA issued - exports orders when an RMA is issued
RMA received - exports orders when an RMA is received
Example 1: Exporting partials from a specific campaign
This setup will include partials from only the "Lander" campaign, campaign Id 1.
Example 2: Exporting partials and sales from a specific campaigns. To add an additional campaign to the export, simply repeat the process and select the appropriate choices.
Now the daily export file will include all sales and partials from both "Lander" campaigns and each in their own file.
When a webhook has been triggered a system generated message will be left in the customer history section of the customer who was exported.
There will be a blue link in the log where you can see what data was sent for this particular customer
If a webhook fails to export we will continuously re-attempt to post to the webhook until it is successful. This is useful for when webhook targets are down for maintenance or experience connection issues.
Please note that Konnektive Test Card orders will not export through the webhook system. |
NOTE: Newly created webhooks grab data from 1 day prior. |