Creating an Export App
Last updated
Last updated
An export app is a set of directions that you provide to SalesIntel to configure the information we send via webhook. The directions include things like your webhook endpoint and headers, but also any descriptive data that you'd want us to include with data delivery, such as record owners or types.
In order to build an export app, you must have access to SalesIntel with an Admin role. Please ask your success team to enable Export Apps, if you do not see this feature in your account.
To build your export app, you'll need the following information:
Your webhook receiver endpoint. This is the endpoint to which we will POST requests. The endpoint must be able to provide a 200 response to an empty request for health checks. (required)
Any required headers for your endpoint. These are in the format of key-value pairs that are required to receive the data on the endpoint. We cannot form this dynamically; they must be fixed values. (optional)
Any values that your operations team would like to have set for new contact or account records. (optional - these values can also be added/update later)
For contacts, we offer the ability to set a contact type (required or optional), contact owner (required or optional), and/or campaign/workflow entry (required or optional). If your team would like to have this information on their records, they will be prompted to include it when they initiate the export.
For companies, we offer the ability to set a record owner (required or optional).
These inclusions will be passed through the webhook for the receiver to process accordingly. The inclusions are applied at the request level, for each record that is part of the request. For example, if James exports 100 contacts, he might request that the contacts are processed as "Leads", assigned to himself, and entered into a campaign for "Upcoming Conferences". These values are included in the webhook body and will apply to the entire file of records that is transmitted, but each request/webhook might have different values based on the end-user's input. It's important that the team building the integration discusses these expectations with the team using the integration before starting work.
To get started, go to the Welcome menu in the upper-right, select Account Settings, and choose Export Apps > Create App. If you do not see this option, please contact your success team to have it added.
First, give your app a name. This is the name your team will see when they go to export from the SalesIntel application, so it should be intuitive, like "ACME Co CRM".
Next, add your receiver endpoint. You can also use a receiver service like requestbin.com to try out the service. Do not url-encode your endpoint; our service will do this for you. If you pre-encode the endpoint, while your in-browser test request may work, production usage will fail.
Add any required headers for your endpoint.
Choose what kind of data is supported by this app. You may send both contact and company data to the same endpoint, but you will need to configure two separate apps.
If you select Contacts for your record type, a new set of options will show in your App Settings. These options control the metadata including in your webhook to describe how to process the exported records. If you don't know which values to include, you may set (or change) these later. Your development team will have to understand and process these instructions to meet the needs of your users.
Include Contact Type: If there are multiple ways a contact can be processed by your destination system and you would like the user to specify their desired type, enable this option. Alternatively, you may also decide that ALL contacts from this integration are processed one way, and then you can build that on the receiver end instead of within the app.
Once this option is enabled, you will see a box to enter the possible values. These values will be shown to the user when they request their export. If you do not select Make Optional, the user will be required to select one of your choices.
Include Contact Owner: If you would like to allow the user to assign these contacts to an owner, enable this option.
Once this option is enabled, you will three options for assigning an owner:
Use user's email address: This will assign the current user's email address, as registered with their SalesIntel account, to the export. The user cannot assign anyone else to own these records and it is not optional.
Use user's full name: This will assign the current user's first and last name, as registered with their SalesIntel account, to the export. The user cannot assign anyone else to own these records and it is not optional.
Pick from list: This will allow you to create a custom list of users the match how you might prefer to refer to them in your destination system. The user will be able to choose from any entries you add to the list. As your organization changes, you may need to update this list. If you do not select Make Optional, the user will be required to assign the records.
Add Contact to Campaign/Workflow: If you would like to allow the user to add these to another campaign, workflow, tag, etc, enable this option. This option will accept a custom list that is displayed to the user and the user can choose from any entries you add. As your organization changes, you may need to update this list.
If you do not select Make Optional, the user will be required to assign the records to a campaign/workflow.
If you select Company for your record type, a new set of options will show in your App Settings. These options control the metadata including in your webhook to describe how to process the exported records. If you don't know which values to include, you may set (or change) these later. Your development team will have to understand and process these instructions to meet the needs of your users.
Include Account Owner: If you would like to allow the user to assign these accounts to an owner, enable this option.
Once this option is enabled, you will three options for assigning an owner:
Use user's email address: This will assign the current user's email address, as registered with their SalesIntel account, to the export. The user cannot assign anyone else to own these records and it is not optional.
Use user's full name: This will assign the current user's first and last name, as registered with their SalesIntel account, to the export. The user cannot assign anyone else to own these records and it is not optional.
Pick from list: This will allow you to create a custom list of users the match how you might prefer to refer to them in your destination system. The user will be able to choose from any entries you add to the list. As your organization changes, you may need to update this list. If you do not select Make Optional, the user will be required to assign the records.
After you save your app, the Availability will be set to Disabled. Disabled apps are not available for users in the platform while you continue to develop. At this point, you will also see an option to Send a Test Record to your endpoint.
