Connectors Reference

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.

 

Status: Preview

Tier: Premium

Version: 1.1.0

 

Actions:

Name

Summary

GetEventSchema (string event)

Get schema of collaboration event

GetEventList ()

Get list of events

ReadSubscriber (string subscriber_id)

Read subscriber information

DeleteSubscriber (string subscriber_id)

Delete subscriber

GetIntegrationList ()

Get list of integrations

GetObjectEventSchema (string integration_id)

Get schema of object event

BulkloadOpportunity (string integration_id, [Optional]string content_type, [Optional]string column_delimiter, [Optional]string Content-Type, [Optional]BulkloadOpportunityParameterBulkload_opportunity_request bulkload_opportunity_request)

Bulk Load Opportunities (data in body)

BulkloadOpportunityFileAttachment (string integration_id, [Optional]string content_type, [Optional]boolean has_header_row, file file)

Bulk Load Opportunities (attachment)

BulkloadData (string integration_id, [Optional]string data_format, [Optional]string column_delimiter, [Optional]string Content-Type, [Optional]BulkloadDataParameterBulkload_request bulkload_request)

Bulk Load Data (data in body)

BulkloadDataFileAttachment (string integration_id, [Optional]string data_format, file file)

Bulk Load Data (attachment)

GetBulkloadStatus (string integration_id, string execution_id, [Optional]boolean include_errors, [Optional]number max_errors)

Get the status of the bulkload operation

GetExternalId (string object_id)

Get external ID for WorkSpan ID

UpdateExternalId (string object_id, [Optional]connect_external_id_request request_body)

Connect an external ID to a WorkSpan ID

ObjectAudit (audit_request audit_request_body, string object_id)

Add Audit information to WorkSpan Object

 

Triggers:

Name

Summary

Subscribe (SubscribeParameterSubscribe_body subscribe_body)

Subscribe to WorkSpan Collaboration Events

SubscribeObjectEvent (SubscribeObjectEventParameterSubscribe_body subscribe_body)

Subscribe to WorkSpan Object Events

SubmitToPartnerCenterObjectEvent (SubmitToPartnerCenterObjectEventParameterSubscribe_body subscribe_body)

Submit Referral to Microsoft Partner Center from WorkSpan

 

Objects:

Name

Summary

audit_request

 

audit_response

 

BulkloadDataParameterBulkload_request

 

BulkloadOpportunityParameterBulkload_opportunity_request

 

bulkload_opportunity_response

 

bulkload_response

 

bulkload_status_response

 

connect_external_id_request

 

event_subscribe_info

 

external_id_response

 

file

file to upload

GetEventListResponse

 

GetEventSchemaResponse

 

GetIntegrationListResponse

 

GetObjectEventSchemaResponse

 

get_external_id_response

 

SubmitToPartnerCenterObjectEventParameterSubscribe_body

 

SubscribeObjectEventParameterSubscribe_body

 

SubscribeParameterSubscribe_body

 

subscribe_resp

 

 

Actions:

GetEventSchema

Summary: Get schema of collaboration event

Description: Get the schema of the WorkSpan Collaboration event

 

Syntax:

WorkSpan.GetEventSchema (string event)

 

Parameters:

Name

Type

Summary

Required

Related Action

event

string

(Name of event)

Name of event

True

 

Returns:

          Type:GetEventSchemaResponse

 

GetEventList

Summary: Get list of events

Description: Get a list of WorkSpan Collaboration events

 

Syntax:

WorkSpan.GetEventList ()

 

Returns:

          Type:GetEventListResponse

 

ReadSubscriber

Summary: Read subscriber information

Description: Read details of subscription

 

Syntax:

WorkSpan.ReadSubscriber (string subscriber_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriber_id

string

(subscriber id assigened by WorkSpan)

subscriber id assigened by WorkSpan

True

 

Returns:

          Type:event_subscribe_info

 

DeleteSubscriber

Summary: Delete subscriber

Description: Delete subscriber

 

Syntax:

WorkSpan.DeleteSubscriber (string subscriber_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriber_id

string

(ID of the subscriber that needs to be deleted)

ID of the subscriber that needs to be deleted

True

 

Returns:

 

GetIntegrationList

Summary: Get list of integrations

Description: Get list of integrations

 

Syntax:

WorkSpan.GetIntegrationList ()

 

Returns:

          Type:GetIntegrationListResponse

 

GetObjectEventSchema

Summary: Get schema of object event

Description: Get the schema of the WorkSpan Object event

 

Syntax:

WorkSpan.GetObjectEventSchema (string integration_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Integration Id)

Integration Id of Object Event Integration

True

 

Returns:

          Type:GetObjectEventSchemaResponse

 

BulkloadOpportunity

Summary: Bulk Load Opportunities (data in body)

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

 

Syntax:

WorkSpan.BulkloadOpportunity (string integration_id, [Optional]string content_type, [Optional]string column_delimiter, [Optional]string Content-Type, [Optional]BulkloadOpportunityParameterBulkload_opportunity_request bulkload_opportunity_request)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Select Integration configured in WorkSpan)

Integration Id of CRM intergation configured in WorkSpan

True

GetIntegrationList

content_type

string

(Content type of data. Allowed formats are .csv and .json)Values: [csv, json]

Content type of data. Allowed formats are .csv and .json

False

column_delimiter

string

(column delimiter (used if content_type is csv))

column delimiter (used if content_type is csv)

False

Content-Type

string

(Content type of data. text/csv or application/json.)Values: [text/csv, application/json]

Content type of data. text/csv or application/json.

False

bulkload_opportunity_request

BulkloadOpportunityParameterBulkload_opportunity_request

 

 

False

 

Returns:

          Type:bulkload_opportunity_response

 

BulkloadOpportunityFileAttachment

Summary: Bulk Load Opportunities (attachment)

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

 

Syntax:

WorkSpan.BulkloadOpportunityFileAttachment (string integration_id, [Optional]string content_type, [Optional]boolean has_header_row, file file)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Select Integration configured in WorkSpan)

Integration Id of CRM intergation, that is configured in WorkSpan

True

GetIntegrationList

content_type

string

(Content type of data. Allowed formats are .csv .xlsx and .json)Values: [xlsx, csv, json]

Content type of data. Allowed formats are .csv .xlsx and .json

False

has_header_row

boolean

(Does excel file has header row?)

Does excel file has header row?

False

file

file

(file to upload)

file to upload

True

 

Returns:

          Type:bulkload_opportunity_response

 

BulkloadData

Summary: Bulk Load Data (data in body)

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

 

Syntax:

WorkSpan.BulkloadData (string integration_id, [Optional]string data_format, [Optional]string column_delimiter, [Optional]string Content-Type, [Optional]BulkloadDataParameterBulkload_request bulkload_request)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Select Integration configured in WorkSpan)

Integration Id of CRM intergation configured in WorkSpan

True

GetIntegrationList

data_format

string

(Content type of data. Allowed formats are .csv and .json)Values: [json, csv]

Format of data. Allowed formats are csv and json

False

column_delimiter

string

(column delimiter (used if content_type is csv))

column delimiter (used if content_type is csv)

False

Content-Type

string

(Content type of data. text/csv or application/json.)Values: [text/csv, application/json]

Content type of data. text/csv or application/json.

False

bulkload_request

BulkloadDataParameterBulkload_request

 

 

False

 

Returns:

          Type:bulkload_response

 

BulkloadDataFileAttachment

Summary: Bulk Load Data (attachment)

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

 

Syntax:

WorkSpan.BulkloadDataFileAttachment (string integration_id, [Optional]string data_format, file file)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Select Integration configured in WorkSpan)

Integration Id of CRM intergation, that is configured in WorkSpan

True

GetIntegrationList

data_format

string

(Format data. Allowed formats are .csv .xlsx and .json)Values: [xlsx, csv, json]

Format data. Allowed formats are .csv .xlsx and .json

False

file

file

(file to upload)

file to upload

True

 

Returns:

          Type:bulkload_response

 

GetBulkloadStatus

Summary: Get the status of the bulkload operation

Description: Get status of bulkload operation

 

Syntax:

WorkSpan.GetBulkloadStatus (string integration_id, string execution_id, [Optional]boolean include_errors, [Optional]number max_errors)

 

Parameters:

Name

Type

Summary

Required

Related Action

integration_id

string

(Integration Id)

Integration Id

True

GetIntegrationList

execution_id

string

(Execution Id (returned bu bulkload step))

Execution ID of an integration execution which is returned from bulk API

True

include_errors

boolean

(Include errors in the response if there are any errors)

Include errors in the response if there are any errors

False

max_errors

number

(Maximum number of errors to return back in the response)

Maximum number of errors to return back in the response

False

 

Returns:

          Type:bulkload_status_response

 

GetExternalId

Summary: Get external ID for WorkSpan ID

Description: Get the  external application’s primary unique identifier

 

Syntax:

WorkSpan.GetExternalId (string object_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

object_id

string

(Object ID of WorkSpan Object (long ID))

Object ID of WorkSpan Object (long ID)

True

 

Returns:

          Type:get_external_id_response

 

UpdateExternalId

Summary: Connect an external ID to a WorkSpan ID

Description: Update WorkSpan Object with external application’s primary unique identifier

 

Syntax:

WorkSpan.UpdateExternalId (string object_id, [Optional]connect_external_id_request request_body)

 

Parameters:

Name

Type

Summary

Required

Related Action

object_id

string

(Object ID of WorkSpan Object (long ID))

Object ID of WorkSpan Object (long ID)

True

request_body

connect_external_id_request

 

 

False

 

Returns:

          Type:external_id_response

 

ObjectAudit

Summary: Add Audit information to WorkSpan Object

Description: Add Audit information to WorkSpanObject

 

Syntax:

WorkSpan.ObjectAudit (audit_request audit_request_body, string object_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

audit_request_body

audit_request

 

 

True

object_id

string

(WorkSpan Object ID (long ID))

Object ID (long ID) of WorkSpan object to be updated with integration status

True

 

Returns:

          Type:audit_response

 

Triggers:

Trigger Subscribe

Summary: Subscribe to WorkSpan Collaboration Events

Description: 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.

 

Syntax:

WorkSpan.Subscribe (SubscribeParameterSubscribe_body subscribe_body)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscribe_body

SubscribeParameterSubscribe_body

 

 

True

 

Returns:

          Type:subscribe_resp

 

Trigger SubscribeObjectEvent

Summary: Subscribe to WorkSpan Object Events

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

 

Syntax:

WorkSpan.SubscribeObjectEvent (SubscribeObjectEventParameterSubscribe_body subscribe_body)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscribe_body

SubscribeObjectEventParameterSubscribe_body

 

 

True

 

Returns:

          Type:subscribe_resp

 

Trigger SubmitToPartnerCenterObjectEvent

Summary: Submit Referral to Microsoft Partner Center from WorkSpan

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

 

Syntax:

WorkSpan.SubmitToPartnerCenterObjectEvent (SubmitToPartnerCenterObjectEventParameterSubscribe_body subscribe_body)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscribe_body

SubmitToPartnerCenterObjectEventParameterSubscribe_body

 

 

True

 

Returns:

          Type:subscribe_resp

 


 

audit_request

Summary:

Description:

 

          Properties:

Name

Type

Summary

field_name

string

 

Field name of Audit Field in WorkSpan.  Values: [partner_center.integration_status]

integration_id

string

 

Integration Id (long ID) of related integration

external_id

string

 

ID from external system (example. CRM Id)

status_code

string

 

Code representing status of audit request.  Values: [SCHEDULED, CREATE_FAILED, UPDATE_FAILED, LINKED]

message

string

 

Additional information for recording in audit log


 

audit_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

object_id

string

 

WorkSpan Object ID (long ID) that was updated

field_name

string

 

Name of WorkSpan field that was updated

status_code

string

 

Updates status


 

BulkloadDataParameterBulkload_request

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

BulkloadOpportunityParameterBulkload_opportunity_request

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

bulkload_opportunity_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

integration_id

string

 

Integration Id

execution_id

string

 

Execution Id

created_at

string(date-time)

 

Creation time


 

bulkload_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

integration_id

string

 

Integration Id

execution_id

string

 

Execution Id

data_format

string

 

Data Format

created_at

string(date-time)

 

Creation time


 

bulkload_status_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

integration_id

string

 

Integration ID

execution_id

string

 

Execution ID

status

string

 

Status of execution  Values: [running, completed]

succcess_count

number

 

Number of records that were processed successfully

error_count

number

 

Number of records with errors

input_count

number

 

Number of records received

skip_count

number

 

Number of records skipped

started_at

string(date-time)

 

Timestamp of starting execution

completed_at

string(date-time)

 

Timestamp of completing execution

include_errors

boolean

 

Flag which indicates whether errors will be returned in the response if any

errors

array of (ErrorsItem)

 

 

 

ErrorsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

message

string

 

Error message

id

string

 

ID of the record which failed

data_row

string

 

The data row which failed

 


 

connect_external_id_request

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

string

 

ID from external system (ex. CRM)


 

event_subscribe_info

Summary:

Description:

 

          Properties:

Name

Type

Summary

subscriber_id

string

 

subscriber_id

name

string

 

Name assigned to the webhook

objectids

array of (string)

 

Object Ids for which webhook is registered

event

array of (string)

 

Events for which webhook is registered

filters

string

 

Filters for events

integraion_id

string

 

Integration id used for object events

subscriber_type

string

 

Should be 'webhook' for webhook


 

external_id_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

external_id

string

 

ID from external system (e.g. CRM)

object_id

string

 

WorkSpan Object ID (long ID)

field_name

string

 

WorkSpan field name where the external_id from an external system is stored


 

file

Summary: file to upload

Description: file to upload

 

          Properties:

Name

Type

Summary


 

GetEventListResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

events

array of (EventsItem)

 

 

 

EventsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

 

name

string

 

 

 


 

GetEventSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetIntegrationListResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

integrations

array of (IntegrationsItem)

 

 

 

IntegrationsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

integration_id

string

 

 

integration_type

string

 

 

description

string

 

 

name

string

 

 

 


 

GetObjectEventSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

get_external_id_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

object_id

string

 

Object ID of WorkSpan Object (long ID)

external_ids

array of (External_idsItem)

 

 

 

External_idsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

field_name

string

 

WorkSpan field name where the external_id from an external system is stored

external_id

string

 

ID from external system (e.g. CRM)

 


 

SubmitToPartnerCenterObjectEventParameterSubscribe_body

Summary:

Description:

 

          Properties:

Name

Type

Summary

subscriber_type

string

 

Should be 'webhook' for webhook

event

string

Submit to partner center event

 

name

string

 

Name of event subscriber

integration_id

string

Select Integration configured in WorkSpan

 

webhook_settings

Webhook_settings

 

 

 

Webhook_settings

Summary:

Description:

 

          Properties:

Name

Type

Summary

callback_url

string

Callback URL

Callback URL

 


 

SubscribeObjectEventParameterSubscribe_body

Summary:

Description:

 

          Properties:

Name

Type

Summary

subscriber_type

string

 

Should be 'webhook' for webhook

event

array of (string)

Subscribe to Object Events

 

name

string

 

Name of event subscriber

integration_id

string

Select Integration configured in WorkSpan

 

object_ids

array of (string)

 

 

filters

string

Filter example:  (stage in [ "closed", "won", "lost" ]) AND (sales_details.partner = "P1")

Filters for events

webhook_settings

Webhook_settings

 

 

 

Webhook_settings

Summary:

Description:

 

          Properties:

Name

Type

Summary

callback_url

string

Callback URL

Callback URL

 


 

SubscribeParameterSubscribe_body

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhook_settings

Webhook_settings

 

 

event

string

Event Name

 

name

string

Subscriber Name

Name assigned to the webhook

object_ids

array of (string)

WorkSpan Object Id

Object Ids for which webhook is registered

filters

string

Filter example:  (stage in [ "closed", "won", "lost" ]) AND (sales_details.partner = "P1")

Filters for events

subscriber_type

string

 

Should be 'webhook' for webhook

 

Webhook_settings

Summary:

Description:

 

          Properties:

Name

Type

Summary

callback_url

string

Callback URL

Callback URL

 


 

subscribe_resp

Summary:

Description:

 

          Properties:

Name

Type

Summary

subscriber_id

string

 

subscriber_id