How Can I Use The Zapier Integration?

How Can I Use The Zapier Integration?


The Zapier integration provides access to:
  • A "Create Transaction" Action
    • This allows you to add or update sales transactions within Sales Cookie. For example, you could create a Zap which calls this action when a new invoice or opportunity is created or updated in your accounting or CRM system. This way, transactions automatically appear in Sales Cookie when your accounting or CRM system changes.
  • A "Rewards Released" Trigger
    • This allows you to be notified when rewards are released within Sales Cookie. For example, you could create a Zap which listens to this trigger and submits payment requests to your payroll or vendor management system. This way, you can automate payment of commissions to beneficiaries as you authorize release of commission rewards.

Zapier Integration Walk-Through
Visit our blog post for a detailed walk-through and examples.

Zapier Deployment
Use this link to add Sales Cookie to your Zapier applications.
Create or Update Transaction Action
To call this action, you must provide relevant fields such as a transaction date, revenue, etc. It's OK for some of those fields to be missing, but you will always need an effective transaction date. A unique ID is also very useful as it uniquely identifies the transaction if you want to update it.

Here is the type of input the action expects (you can omit some fields - see above):
{
  "date": "2020-12-30T08:00:00+00:00",
  "uniqueId": "o-12356",
  "revenue": 10,
  "profit": 5,
  "currency": "USD",
  "transactionStatus": "Closed Won",
  "customer": "Customer",
  "product": "Product",
  "owner1": "Owner #1",
  "owner2": "Owner #2",
  "owner3": "Owner #3",
  "team1": "Team #1",
  "team2": "Team #2",
  "team3": "Team #3",
  "quantity": 10,
  "costPerUnit": 2.5,
  "taxes": 6.66,
  "otherText1": "Other #1",
  "otherText2": "Other #2",
  "otherText3": "Other #3",
  "otherNumeric1": 1,
  "otherNumeric2": 2,
  "otherNumeric3": 3,
  "otherDate1": "2020-12-01",
  "otherDate2": "2020-12-02",
  "otherDate3": "2020-12-03",
  "Id": "018c941d-c52b-11ea-bf21-0003ffd1b5e6"
}

Rewards Released Trigger
When listening to this trigger, you will be asked to provide an incentive plan's name. When you release rewards for this plan's calculations (or a add a manual reward), you will receive a notification.

Here is the type of notification data you will receive:
[{
  "id": "71cc9356-b0b8-11ea-bf22-0003ffd1cd5b",
  "planName": "One-Off Sales Contest",
  "calculationName": "Sample Calculation",
  "calculationStatus": "Rewards Released",
  "calculationStart": "2020-04-01T00:00:00Z",
  "calculationEnd": "2020-06-30T00:00:00Z",
  "beneficiary": "Daniel Martinez (DanielMartinez@example.com)",
  "beneficiaryFirstName": "Daniel",
  "beneficiaryLastName": "Martinez",
  "beneficiaryEmailAddress": "DanielMartinez@example.com",
  "beneficiaryEnrollment": "Ok",
  "managerApproval": "Ok",
  "rewardType": "% of Revenue",
  "rewardDetails": "5% of revenue (this level)",
  "rewardValue": 86.2125,
  "rewardValueCurrency": "USD",
  "beneficiaryValue": 86.2125,
  "beneficiaryValueCurrency": "USD",
  "assignmentPercent": 100,
  "attainmentLabel": "L1",
  "attainmentDifficulty": "Trivial",
  "attainmentValue": 1724.25,
  "attainmentThreshold": 0,
  "attainmentMetric": "revenue",
  "attainmentMeasure": "total",
  "attainmentUser": "Daniel Martinez (DanielMartinez@example.com)",
  "attainmentTeam": "",
  "attainmentPercentage": 34.49,
  "recoverable": "No",
  "nonDeductible": "No",
  "estimated": "No",
  "manual": "No",
  "created": "2020-06-17T16:34:47Z",
  "updated": "2020-06-17T00:00:00Z",
  "createdBy": "Admin (admin@example.com)",
  "updatedBy": "Admin (admin@example.com)"
}]

    • Related Articles

    • How Can I Use The Transaction Import API?

      The data import API allows you to create (or update) sales transactions within Sales Cookie using HTTP requests. Three options are available to import sales transactions using an API: Use the CSV Upload API (easiest) Manually upload a sample CSV file ...
    • How Can I Use The CSV Upload API?

      This article is about CSV transaction upload API. This is by far the easiest way to upload sales transactions, and it is also blazing fast. About 1-3 lines of code are required to upload transactions. All you need to do is prepare a CSV file and then ...
    • How Can I Use the Full Transaction Import Rest API?

      This article is about the full transaction import REST API. Click here for more options. Importing Sales Transactions To import transaction data, follow these 3 steps: Step 1 - Get your API key Step 2 - Prepare for import by mapping your fields to ...
    • Can I Use Restricted Keys For Stripe Access?

      When you add a Stripe connection to your workspace, you can choose to use a restricted key. This allows you to safeguard your Stripe environment by: Limiting access to read-only mode Limiting access to those entities required to calculate commissions ...
    • How Can I Use the Simplified Transaction Import Rest API?

      This article is about the simplified transaction import REST API. Click here for more options. Importing Sales Transactions To import transaction data, follow these 2 steps: Step 1 - Get your API key Step 2 - Import transactions by making a POST call ...