Zapier App Documentation

This page provides an explanation on how to use the SalesDesk Zapier App. For information on how to use Zapier, please refer to the Zapier website. For further support on using the SalesDesk Zapier app please contact support@salesdesk.app

For full API access, please go here.

Authentication

To authenticate the SalesDesk Zapier app with SalesDesk, go to the SalesDesk Settings section and then the Developer sub-section. Create a new API key and copy the public and private keys. Keep the private key secure and safe.

Once you have your public and private key you are ready to connect to you SalesDesk account from Zapier. You did this by setting up a Zapier Connection. Choose Add connection and choose SalesDesk from the drop-down option.

When the login screen appear enter your public key in the first input box and your private key in the second.

Triggers

Notification Rule Triggered

When a notification rule is set up in SalesDesk, it can be referenced in this trigger to commence a Zap. The notification rules can be accessed in the settings section of SalesDesk as follows.

Each rule can be accessed in the Notification Rule Triggered SalesDesk trigger in Zapier as follows:

Once you have referenced the notification rule set up in SalesDesk, your Zap will automatically be triggered and run when the event that triggers that rule is fired.

The triggered event has the following structure:

{
 "recordId": "860548521846847",
 "createdAt": "1740516654952",
 "createdByName": "Jon Folland",
 "createdBy": "118753361790548",
 "externalId": "369472042090953",
 "eventType": "RECORD_NOTE_ADDED",
 "id": "59b03f32-43d1-44c9-85e1-436ab24a3d0e",
 "params": {},
 "objectId": 5,
 "baseObjectId": 5
}

The id field is the id for the record that created the event.

Actions

Get Record

This action is used to get the details for a specific record in SalesDesk. The record id must be specified as an input parameter. It is common for this action to follow the trigger above as the record id can be accessed from the event object (id) as seen above. This returns the record JSON structure from SalesDesk:

{
 "version": 18,
 "createdAt": 1718729969610,
 "updatedBy": 118753361790548,
 "createdBy": 861416708599989,
 "name": "Edin Opportunity",
 "creationType": "User",
 "objectId": 5,
 "fieldValues": [
   {
     "value": "Fred",
     "fieldName": "name"
   },
   {
     "value": 100000,
     "fieldName": "value"
   },
   {
     "value": "proposal",
     "fieldName": "stage"
   },
   {
     "value": 10,
     "fieldName": "probability"
   },
   {
     "value": 1722384000000,
     "fieldName": "closeDate"
   },
   {
     "value": null,
     "fieldName": "source"
   },
   {
     "value": null,
     "fieldName": "products"
   },
   {
     "value": null,
     "fieldName": "description"
   },
   {
     "value": 861416708599989,
     "fieldName": "accountManager"
   },
   {
     "value": null,
     "fieldName": "resellers"
   }
 ],
 "deleted": false,
 "updatedAt": 1740516434906,
 "ownedBy": 861416708599989,
 "id": 432056223429005,
 "objectVersion": 39,
 "sharedWorkspaceIds": []
}

Get Record Field Value

This action is used to get the value of a specific field belonging to a SalesDesk record. The action requires the record id and the record field name. The record id references the id for the specific record and the record field name references the name of the particular field for that record. An example of the JSON structure returned is as follows:

{
 "value": "proposal"
}

Set Record Field Value

This action is used to set the value of a specific field belonging to a SalesDesk record. The action requires the record id, the record field name and the new value for that record field. Once the field value has been updated the entire record is returned. An example of the JSON structure returned is as follows:

{
 "version": 18,
 "createdAt": 1718729969610,
 "updatedBy": 118753361790548,
 "createdBy": 861416708599989,
 "name": "Edin Opportunity",
 "creationType": "User",
 "objectId": 5,
 "fieldValues": [
   {
     "value": "Fred",
     "fieldName": "name"
   },
   {
     "value": 100000,
     "fieldName": "value"
   },
   {
     "value": "proposal",
     "fieldName": "stage"
   },
   {
     "value": 10,
     "fieldName": "probability"
   },
   {
     "value": 1722384000000,
     "fieldName": "closeDate"
   },
   {
     "value": null,
     "fieldName": "source"
   },
   {
     "value": null,
     "fieldName": "products"
   },
   {
     "value": null,
     "fieldName": "description"
   },
   {
     "value": 861416708599989,
     "fieldName": "accountManager"
   },
   {
     "value": null,
     "fieldName": "resellers"
   }
 ],
 "deleted": false,
 "updatedAt": 1740516434906,
 "ownedBy": 861416708599989,
 "id": 432056223429005,
 "objectVersion": 39,
 "sharedWorkspaceIds": []
}

Create Lead

This action is used to create a new Lead record in SalesDesk. The following fields can be specified:

first_name: The Lead's first name
surname: The Lead's surname
email_address: The Lead's email address (correctly formatted)
mobile_number: The Lead's mobile number
title: The Lead's job title
company: The Lead's company name
linked_in: The URL for the Lead's LinkedIn porfile

The action returns the id of the new Lead that has been created as follows:

{
  "record_id": "432056223429005"
}

Add Note to Record

This action allows you to add a note to an existing SalesDesk record. Each record can support the addition of one or more notes. The action requires the record id and the note text (in plain text).

The action then returns the note as a rich text string:

{
 "value": {
   "message": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":\"left\"},\"content\":[{\"type\":\"text\",\"text\":\"test\"}]}]}"
 }
}

Find User By Email

This action supports the retrieval of a Lead or Contact record based on their unique email address. The action requires an email value. If the record is found, its record id is returned as follows:

{
 "recordId": 174859398376077
}

If the record does not exist the value returned is -1.