Help Centre

Use the API instructions to instantly sync your customers from other platforms to Salesfire.

Syncing data to Salesfire

From the Salesfire dashboard menu, head to the Settings option and select API from the menu.

Monitoring

The monitoring tab will allow you to view the activity and log of any data requests that are being sent to Salesfire via an API. This will include trends such as successful data passes and any errors that could potentially occur. 

Endpoints

The Endpoints tab will provide a log of all the endpoints that have been created. The View option will detail instructions on how the data must be passed to Salesfire. 

Choose a Customer List:

1. From the dropdown, select the list you want to sync.
2. Once selected, you’ll see a special API link for that list (it will look something like: https://api.salesfire.co.uk/client/{site}/customers/{list}).

Add Customer Data:

1. You’ll be sending customer info like email, phone number, marketing preferences and custom attributes. Email or phone number (must have at least one)
2. Type of messages: MARKETING or TRANSACTIONAL. How they want to be contacted: EMAIL or SMS Option to update existing profiles (yes/no)

Security Step

1. Salesfire needs to make sure the data is coming from your chosen site. This is done automatically using a special code (called X-Signature) when the data is sent.

Validation Rules:

1. Every customer must have either an email or phone number.
2. Types and channels must be all uppercase (MARKETING, TRANSACTIONAL, EMAIL, SMS).
3. If you choose to update existing profiles, the system will skip duplicates.
4. To update or create a attributes in the request you can pass an attributes object with key value pairs please follow this formatting:

the Key - (the name of the attribute) must be a string, not contain spaces, be lowercase, start with a letter and contain only lowercase letters, numbers, and underscores (snake_case). Examples: 'name', 'date_of_birth.

the Value - (the value of the attribute) must be a string or null.

Please refer to the Curl example in the Authentication tab for an example on how to send custom attribute data to Salesfire.

The following information may be useful for your developer to assist with syncing Email and SMS data from your chosen platform and connecting this to Salesfire.

Setting up a List for your data sync

Within the Audiences tab of your Salesfire dashboard you will find the Segments & Lists tab.

Follow the API Instructions button to begin the steps in the flight out modal to sync your customers into the Salesfire platform.

A list must be selected from the List dropdown. Once selected the list API URL will appear: example
https://api.salesfire.co.uk/client/{site}/customers/{list}

It is important that an X-Signature is added to the header, this allow Salesfire to verify the authenticity of the request.

This value will need to be a HMAC-SHA-256 hash of the body using the secret as the key. The Secret can be found below the X-Signature section in the flight out modal.

The data in the request will appear as follows:

{
  "email": "test@salesfire.com",
  "mobile_number": "123456789",
  "types": [
    "MARKETING",
    "TRANSACTIONAL"
  ],
    "channels": [
    "EMAIL",
    "SMS"
  ],
  "update_existing": true
}

Please note, there is a validation error messages to prompt if the data structure is invalid. Validation rules can be found in the above section.

If you are having issues syncing customers API and do not see an error message you may need to set the header Accept: application/json in the request. Otherwise, you may be redirected instead of seeing the validation error message.