PartnerStack Workato Connector

PartnerStack helps some of the largest, and fastest growing companies in the world to scale revenue through Partnerships by connecting them to the PartnerStack network of market ready partnerships.

The PartnerStack platform provides partners and channel leaders functionality to automate onboarding, engagement, sales attribution, and commission payouts.

Workato allows you to connect your channel activity in PartnerStack with the sales, marketing, and productivity apps used across your organization.

API version

The PartnerStack connector uses the PartnerStack REST API.

Supported editions and versions

Workato connects programs on any PartnerStack plan.

How to connect to PartnerStack on Workato

The PartnerStack connector uses Basic Auth of your PartnerStack Public and Private keys, found in company settings.

  • Connection name

Give this PartnerStack connection a unique name that identifies which PartnerStack company it is connected to.

  • Sandbox (Test Mode)

To create Test objects in your PartnerStack account, simply use the Test API credentials found in company settings.

  • Advanced - API URL

Leave this blank.

Roles and permissions required to connect

PartnerStack company users must be Admin or have Full ‘Integrations’ permissions to access API credentials.

Each PartnerStack company has a single set of Production and Test API credentials which are scoped to allow Read/Write access to all data in that company account.

Triggers

Monitor real-time events

PartnerStack supports a single trigger that can be configured to target events on various objects. The events available to monitor are determined by the object being monitored.

PartnerStack currently supports monitoring events on the following objects

  • Applications
  • Customers
  • Deals
  • Leads
  • Partnerships
  • Partner Teams

Input fields

FieldDescription
ObjectSelect the object type in PartnerStack you hope to monitor.
Events to MonitorThe event type you want to monitor for this object
Forms to scope events toOptional field. Select the application forms you’d like to monitor. Helpful if the recipe is only targeted at certain groups.

Application Events

Potential partners can submit applications to join a program hosted on PartnerStack. The application object support the following events

  • Application Created
  • Application Approved
  • Application Declined

Output fields

The output of the event contains the application form data, associated group, and partner key.

FieldDescription
ContentFields and content submitted with the application form
Decline ReasonThe reason provided for a decline application
ApprovedThe attributes of the object which you want to update. Any fields left blank will not be changed from its original value.
KeyInternal key reference for the submission
Partner KeyThe unique identifier
Group.keyInternal reference key for the applications associated group
Group.nameInternal name for the applications associated group
Group.slugSlugified version of the group name
created_atEpoch millisecond timestamp
updated_atEpoch millisecond timestamp of the last change to this application (submission, approved, or declined)

Customer Events

Customers represent the user’s of your application who have been referred by a partner. The customers object supports the following events

  • Customer Created
  • Customer Updated
  • Customer Deleted

Output fields

The output of the event contains the customer details, and referring partner key

FieldDescription
KeyInternal key reference for the submission
EmailEmail of the customer
NameName of the customer
Partner KeyThe unique identifier
Provider KeyExternal key reference to your billing system. Utilized in webhook integrations.
TestBoolean, where if True then the customer has been created by a Test mode partner.
Source typeThe source that created the customer (Link, Deal, Lead
Source keyThe internal key reference to the related object that created the customer
Created atEpoch millisecond timestamp
Updated atEpoch millisecond timestamp of the last change to this application (submission, approved, or declined)
ArchivedBoolean, where if True then the customer has been deleted.

Deal Events

The PartnerStack pipeline objects of Deals represent referrals that partners have registered as business opportunities within your sales process. The Deals objects support the following events:

  • Deal created
  • Deal updated
  • Deal stage updated

Output fields

The output of the event contains the deals form data, associated partner key.

FieldDescription
KeyInternal key reference for the submission
Partner KeyThe unique identifier
Account nameThe name of the prospects business
Contact First NameThe first name of the prospect’s contact
Contact Last NameThe last name of the prospect’s contact
StageThe deals current pipeline stage (working, contract out, etc)
Lost ReasonIf ‘closed/lost’ stage, then the reason the deal was not won.
Close DateThe date the prospect closed in format YYYY-MM-DD
AmountValue of the deal in cents (assumed to be USD)
Additional FieldsJSON body of custom fields configured for this deal form.
Created atEpoch millisecond timestamp
Updated atEpoch millisecond timestamp of the last change to the deal record.

Lead Events

The PartnerStack pipeline objects of Leads represent referrals that partners have registered as business opportunities within your sales process. The Leads object supports the following events:

  • Lead created
  • Lead updated
  • Lead approved
  • Lead declined

Output fields

The output of the event contains the lead form data, and associated partner key.

FieldDescription
KeyInternal key reference for the submission
Partner KeyThe unique identifier
StatusThe deals current pipeline stage (working, contract out, etc)
NameThe full name of the lead being submitted
EmailThe Email of the lead being submitted
ApprovedBoolean, where True means the Lead has been approved by a partner manager
Additional FieldsJSON body of custom fields configured for this lead form.
Created atEpoch millisecond timestamp
Updated atEpoch millisecond timestamp of the last change to the lead record.

Partnership Events

The PartnerStack partnerships object represents an entity - typically an individual or an organization - that your company has partnered with. The Partnership object supports the following events:

  • Partnership created
  • Partnership updated
  • Partnership group change
  • Partnership tags updated

Output fields

The output of the event contains the partnership, group, tag, and partner manager data.

FieldDescription
EmailThe email of the primary partner contact
First NameThe first name of the primary partner contact
Last nameThe last name of the primary partner contact
KeyUnique internal identifier for this partnership record
Partner KeyThe unique identifier for the partner
Created atEpoch millisecond timestamp
Updated atEpoch millisecond timestamp of the last change to the lead record.
Manager NameThe full name of the partner account manager assign to this partner
Manager EmailThe email of the partner account manager assign to this partner
EventThe name of the event being monitored
Group.keyThe internal key of the partner’s group
Group.nameThe name of the Partner’s current group
Group.slugThe slugified version of the group name
Tier.keyThe internal key of the Partner’s current tier
Tier.nameThe name of the Partner’s current Tier
TagsList of Partner’s current tags
Tags Added(tags updated event only) Lists tags added to the partnerships
Tags Removed(tags updated event only) Lists tags removed from the partnerships
Team.keyInternal key of the Partner’s team
Team.nameThe name of the Partners team - typically the name of the company or organization.

Partner Team Events

The PartnerStack Partner Team object represents a collections of contacts all working under a single partner entity, such as sales team at an agency or other organization. The Partnership team object supports the following events:

  • Partner Team member joined

Output fields

The output of the event contains the partner contact information, and associated partner team.

FieldDescription
Team.keyInternal key of the Partner’s team
Team.nameThe name of the Partners team - typically the name of the company or organization.
First NameThe first name of the primary partner contact
Last nameThe last name of the primary partner contact
EmailThe email of the primary partner contact
Joined atEpoch millisecond timestamp when the partner contact joined the team

Training Events

The PartnerStack Training events represent completion events in an SAP Litmos instance connected to a PartnerStack company account. The Training object supports the following events:

  • Training course completed
  • Training learning path completed

Output fields

The output of the event contains the training data, and associated partner data.

FieldDescription
IDInternal identifier of the course completed
NameName of the course or learning path completed
Partnership blockBlock containing all information about the partner who completed training. See Partnership events for details.
Company KeyInternal reference identifier for your partnerstack company instance
Completed atEpoch millisecond timestamp when the course or learning path was completed

Transaction Events

The PartnerStack Transaction object represents a purchase made by a customer (end user) of your software or service. The transaction object supports the following events:

  • Transaction created

Output fields

The output of the event contains the transaction data, and associated customer.

FieldDescription
AmountTransaction amount in the native currency, represented in cents or lowest denomination
Currency3-letter currency code of the transaction
Amount USDTransaction amount in United States Dollar, converted using spot foreign exchange from openexchangerates.org
Customer KeyExternal key representing the end customer in your system.
KeyInternal key representing the end customer. Generated by PartnerStack
Category keyOptional category of the transaction
Product keyOptional product identifier of the transaction
Created atEpoch millisecond timestamp
Updated atEpoch millisecond timestamp of the last change to the transaction

Actions

When working with PartnerStack actions in workato, those familiar with the objects inside their PartnerStack account will find it easy to automate program management tasks.

The PartnerStack connector organizes actions into common HTTP-style requests, providing standard CRUD (create, read, update, delete) actions, as well as actions for object search and conversion.

Create Record

This action allow you to create a variety of records in PartnerStack. This action currently supports creating the following objects:

  • Action
  • Customer
  • Deal
  • Lead
  • Partnership
  • Reward

Input data

The input data for each of these objects will change with each object. Select an object and the connector will display the available fields.

Output data

If submitted successfully the connector will return the inputted data, and a 200 code.

Search Records

This action will find and return one or multiple records that match the inputted search criteria. You can search for the following object types:

  • Lead
  • Deal
  • Customer
  • Transaction

Input Data

Refine your search by using

  • Min and max created at dates for the record
  • Min and max updated at dates for the record
  • associated partner key
  • associated group name
  • add a limit the number of results to returned

Output data

If records are found, the connector will return a JSON blob of the objects.

Get Records

This action will return a record that matches the inputted key and object criteria. You can search for the following object types:

  • Lead
  • Deal
  • Customer
  • Partnership

Input Data

Input the object type, and the internal key of the object.

Output data

If submitted successfully the connector will return the full object data, and a 200 code.

Update Records

This action allows you to update existing records in PartnerStack. This action currently supports updating the following objects:

  • Lead
  • Deal
  • Customer
  • Partnership

Input Data

The input data for each of these objects will change with each object. Select an object and the connector will display the available fields.

Output data

If submitted successfully the connector will return the inputted data, and a 200 code.

Modify Tags

This action allows you to add and remove tags from a partnership.

Input Data

Input the key of the partner, tags to be added, and/or tags to be removed

Output data

If submitted successfully the action will return the partnership with the updated tags, and a 200 code.

Delete Records

This action allows you to delete existing records in PartnerStack. This action currently supports deleting the following objects:

  • Lead
  • Deal
  • Customer
  • Partnership

Input Data

Input the key of the record to be deleted.

Output data

If submitted successfully the connector will return the deleted data, and a 200 code.

Convert Object

This action allows you to convert Lead and Deal objects to a customer object.

Input Data

Input the key of the record to be converted, along with an email and external key for the customer.

Output data

If submitted successfully the connector will return the new customer, and a 200 code.

Working with File attachments

PartnerStack supports attaching files to the Deals object. The connector provides two actions to collect one or multiple attachments on a deal, and save the contents to an external system.

Learn more about how Workato handles files and attachments.

Get record attachment list

This action allows you to pull a list of attachments on a targeted object, such as a deal.

Input the Deal key, and if found the action will return the list of attachments and keys.

Get attachment details

This action allows you capture the contents of an attachment to use in another recipe action.

Input the object key, and the file key (returned by ‘get record attachment list’), and if found the action will return the file as a binary object. Lea


Did this page help you?