WorkSpan

WorkSpan is a collaborative platform to plan, execute, and drive revenue with partners. Manage your partner programs and partner initiatives on WorkSpan, and connect seamlessly with internal and partner applications. You can integrate your CRM, Partner Center, Collaboration tools and Productivity tools to WorkSpan.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	WorkSpan API Support
URL	https://support.workspan.com
Email	api-team@workspan.com

Connector Metadata
Publisher	WorkSpan
Website	https://www.workspan.com
Categories	Marketing;Sales and CRM
Privacy policy	https://www.workspan.com/privacy-policy

WorkSpan is a collaborative platform for connecting with your partners and managing your partner programs. WorkSpan powers successful partner programs for some of the world's leading technology companies. Connect your popular and preferred applications with WorkSpan Ecosystem Cloud to enrich the value of your sales opportunities with the power of your partner ecosystem. With the WorkSpan Connector users can supercharge and accelerate their ecosystem and partnering motions by connecting seamlessly with a number of business applications such as Dynamics 365 CRM and Salesforce CRM. Users can synchronize data in their premier CRM applications with WorkSpan. Users can also connect with collaboration and productivity applications such as Microsoft Teams, Slack and OneDrive. Users can stay notified of the various collaboration related events in WorkSpan such as assigned tasks, comments on objects, and membership related occurrences on objects. The WorkSpan connector boosts productivity, maintains data integrity across applications, and delivers timely data and value to the business application users. As a result, organizations using the connector will experience cost savings, increased revenues, streamlined & accelerated sales processes, and enhanced reporting.

Prerequisites

The organization must be a registered company on WorkSpan

How to get credentials

Users should be authenticated to use the connector. WorkSpan provides access to the connector and to Data in WorkSpan for configured Application Users in WorkSpan. Detailed steps are available at https://support.workspan.com

Known issues and limitations

No known issues

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Environment: Sandbox or Production	string	Sandbox environment or production environment	True
Application User Id	string	Id of WorkSpan Application User	True
Application User Secret	securestring	Application User Secret	True
WorkSpan App Hostname. Example: demo.workspan.com /app.workspan.com	string	Enter Host Name (without https) Example: demo.workspan.com / app.workspan.com	True
Notes	string	Notes for connection	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add Audit information to WorkSpan Object	Add Audit information to WorkSpanObject
Bulk Load Data (attachment)	Upload an input file to your integration. Allowed formats are .xlsx, .json and .csv
Bulk Load Data (data in body)	Upload input data as a request body to your integration. Allowed formats are .csv and .json
Bulk Load Opportunities (attachment)	Upload an input file to your integration. Allowed formats are .xlsx, .json and .csv
Bulk Load Opportunities (data in body)	Upload input data as a request body to your integration. Allowed formats are .csv and .json
Connect an external ID to a WorkSpan ID	Update WorkSpan Object with external application’s primary unique identifier
Get external ID for WorkSpan ID	Get the external application’s primary unique identifier
Get list of reports	List reports
Get the status of the bulkload operation	Get status of bulkload operation
Read report data	Read report data

Add Audit information to WorkSpan Object

Operation ID:

ObjectAudit

Add Audit information to WorkSpanObject

Parameters

Name	Key	Required	Type	Description
field_name	field_name	True	string	Field name of Audit Field in WorkSpan.
integration_id	integration_id		string	Integration Id (long ID) of related integration
external_id	external_id		string	ID from external system (example. CRM Id)
status_code	status_code	True	string	Code representing status of audit request.
message	message	True	string	Additional information for recording in audit log
WorkSpan Object ID (long ID)	object_id	True	string	Object ID (long ID) of WorkSpan object to be updated with integration status

Returns

Body

audit_response

Bulk Load Data (attachment)

Operation ID:

BulkloadDataFileAttachment

Upload an input file to your integration. Allowed formats are .xlsx, .json and .csv

Parameters

Name	Key	Required	Type	Description
Select Integration configured in WorkSpan	integration_id	True	string	Integration Id of CRM intergation, that is configured in WorkSpan
Format data. Allowed formats are .csv .xlsx and .json	data_format		string	Format data. Allowed formats are .csv .xlsx and .json
file to upload	file	True	file	file to upload

Returns

Body

bulkload_response

Bulk Load Data (data in body)

Operation ID:

BulkloadData

Upload input data as a request body to your integration. Allowed formats are .csv and .json

Parameters

Name	Key	Required	Type	Description
Select Integration configured in WorkSpan	integration_id	True	string	Integration Id of CRM intergation configured in WorkSpan
Content type of data. Allowed formats are .csv and .json	data_format		string	Format of data. Allowed formats are csv and json
column delimiter (used if content_type is csv)	column_delimiter		string	column delimiter (used if content_type is csv)
Content type of data. text/csv or application/json.	Content-Type		string	Content type of data. text/csv or application/json.
data to be uploaded	bulkload_request			For content type 'CSV': Data rows as csv. first row will be column headers. For content type 'JSON', data format is array: [ { key1 : value, key2 : value}, { key1 : value, key2 : value } ]

Returns

Body

bulkload_response

Bulk Load Opportunities (attachment)

Operation ID:

BulkloadOpportunityFileAttachment

Upload an input file to your integration. Allowed formats are .xlsx, .json and .csv

Parameters

Name	Key	Required	Type	Description
Select Integration configured in WorkSpan	integration_id	True	string	Integration Id of CRM intergation, that is configured in WorkSpan
Content type of data. Allowed formats are .csv .xlsx and .json	content_type		string	Content type of data. Allowed formats are .csv .xlsx and .json
Does excel file has header row?	has_header_row		boolean	Does excel file has header row?
file to upload	file	True	file	file to upload

Returns

Body

bulkload_opportunity_response

Bulk Load Opportunities (data in body)

Operation ID:

BulkloadOpportunity

Upload input data as a request body to your integration. Allowed formats are .csv and .json

Parameters

Name	Key	Required	Type	Description
Select Integration configured in WorkSpan	integration_id	True	string	Integration Id of CRM intergation configured in WorkSpan
Content type of data. Allowed formats are .csv and .json	content_type		string	Content type of data. Allowed formats are .csv and .json
column delimiter (used if content_type is csv)	column_delimiter		string	column delimiter (used if content_type is csv)
Content type of data. text/csv or application/json.	Content-Type		string	Content type of data. text/csv or application/json.
data to be uploaded	bulkload_opportunity_request			For content type 'CSV': Data rows as csv. first row will be column headers. For content type 'JSON', data format is array: [ { key1 : value, key2 : value}, { key1 : value, key2 : value } ]

Returns

Body

bulkload_opportunity_response

Connect an external ID to a WorkSpan ID

Operation ID:

UpdateExternalId

Update WorkSpan Object with external application’s primary unique identifier

Parameters

Name	Key	Required	Type	Description
Object ID of WorkSpan Object (long ID)	object_id	True	string	Object ID of WorkSpan Object (long ID)
field_name	field_name		string	Field name of external ID in WorkSpan. If empty, default field name of external id field will be used. Default field names are: opportunity object: 'sales_details.crm_opportunity_id'; Accound object: 'account_info.external_account_id'
external_id	external_id	True	string	ID from external system (ex. CRM)

Returns

Body

external_id_response

Get external ID for WorkSpan ID

Operation ID:

GetExternalId

Get the external application’s primary unique identifier

Parameters

Name	Key	Required	Type	Description
Object ID of WorkSpan Object (long ID)	object_id	True	string	Object ID of WorkSpan Object (long ID)

Returns

Body

get_external_id_response

Get list of reports

Operation ID:

GetReportList

List reports

Parameters

Name	Key	Required	Type	Description
number	number		integer	number
size	size		integer	size

Returns

Name	Path	Type	Description
id	id	string	id
name	name	string	name

Get the status of the bulkload operation

Operation ID:

GetBulkloadStatus

Get status of bulkload operation

Parameters

Name	Key	Required	Type	Description
Integration Id	integration_id	True	string	Integration Id
Execution Id (returned bu bulkload step)	execution_id	True	string	Execution ID of an integration execution which is returned from bulk API
Include errors in the response if there are any errors	include_errors		boolean	Include errors in the response if there are any errors
Maximum number of errors to return back in the response	max_errors		number	Maximum number of errors to return back in the response

Returns

Body

bulkload_status_response

Read report data

Operation ID:

GetReportData

Read report data

Parameters

Name	Key	Required	Type	Description
Report Id	reportId	True	integer	Report Id
colId	colId		string
negate	negate		boolean
op	op		string
type	type		string
op	op		string
number	number	True	integer
size	size	True	integer

Returns

Body

ReportDataResponse

Triggers

Submit Referral to Microsoft Partner Center from WorkSpan	This trigger is fired when WorkSpan user asks to submit opportunity to Microsoft Partner Center
Subscribe to WorkSpan Collaboration Events	Subscribe to various collaboration events such as creates and updates on membership, tasks and comments to drive and enhance communication with your internal and partner network.
Subscribe to WorkSpan Object Events	Subscribe to various object events such as creates and updates on Opportunities to increase the visibility of your partner influence

Submit Referral to Microsoft Partner Center from WorkSpan

Operation ID:

SubmitToPartnerCenterObjectEvent

This trigger is fired when WorkSpan user asks to submit opportunity to Microsoft Partner Center

Parameters

Name	Key	Required	Type	Description
name	name	True	string	Name of event subscriber
Select Integration configured in WorkSpan	integration_id	True	string

Returns

The outputs of this operation are dynamic.

Subscribe to WorkSpan Collaboration Events

Operation ID:

Subscribe

Subscribe to various collaboration events such as creates and updates on membership, tasks and comments to drive and enhance communication with your internal and partner network.

Parameters

Name	Key	Required	Type	Description
Event Name	event	True	string
Subscriber Name	name	True	string	Name assigned to the webhook
WorkSpan Object Id	object_ids		array of string	Object Ids for which webhook is registered
Filter example: (stage in [ "closed", "won", "lost" ]) AND (sales_details.partner = "P1")	filters		string	Filters for events

Returns

The outputs of this operation are dynamic.

Subscribe to WorkSpan Object Events

Operation ID:

SubscribeObjectEvent

Subscribe to various object events such as creates and updates on Opportunities to increase the visibility of your partner influence

Parameters

Name	Key	Required	Type	Description
Subscribe to Object Events	event	True	array of string
name	name	True	string	Name of event subscriber
Select Integration configured in WorkSpan	integration_id	True	string
object_ids	object_ids		array of string
Filter example: (stage in [ "closed", "won", "lost" ]) AND (sales_details.partner = "P1")	filters		string	Filters for events

Returns

The outputs of this operation are dynamic.

Definitions

bulkload_opportunity_response

Name	Path	Type	Description
integration_id	integration_id	string	Integration Id
execution_id	execution_id	string	Execution Id
created_at	created_at	date-time	Creation time

bulkload_response

Name	Path	Type	Description
integration_id	integration_id	string	Integration Id
execution_id	execution_id	string	Execution Id
data_format	data_format	string	Data Format
created_at	created_at	date-time	Creation time

bulkload_status_response

Name	Path	Type	Description
integration_id	integration_id	string	Integration ID
execution_id	execution_id	string	Execution ID
status	status	string	Status of execution
succcess_count	succcess_count	number	Number of records that were processed successfully
error_count	error_count	number	Number of records with errors
input_count	input_count	number	Number of records received
skip_count	skip_count	number	Number of records skipped
started_at	started_at	date-time	Timestamp of starting execution
completed_at	completed_at	date-time	Timestamp of completing execution
include_errors	include_errors	boolean	Flag which indicates whether errors will be returned in the response if any
errors	errors	array of object
message	errors.message	string	Error message
id	errors.id	string	ID of the record which failed
data_row	errors.data_row	string	The data row which failed

external_id_response

Name	Path	Type	Description
external_id	external_id	string	ID from external system (e.g. CRM)
object_id	object_id	string	WorkSpan Object ID (long ID)
field_name	field_name	string	WorkSpan field name where the external_id from an external system is stored

get_external_id_response

Name	Path	Type	Description
object_id	object_id	string	Object ID of WorkSpan Object (long ID)
external_ids	external_ids	array of object
field_name	external_ids.field_name	string	WorkSpan field name where the external_id from an external system is stored
external_id	external_ids.external_id	string	ID from external system (e.g. CRM)

audit_response

Name	Path	Type	Description
object_id	object_id	string	WorkSpan Object ID (long ID) that was updated
field_name	field_name	string	Name of WorkSpan field that was updated
status_code	status_code	string	Updates status

ReportDataResponse

Name	Path	Type	Description
endOfList	endOfList	boolean
results	results	array of
version	version	integer