Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

CreateWorkflowUserInboxSubscription

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/CreateWorkflowUserInboxSubscription

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateWorkflowUserInboxSubscription

Creates a new workflow user inbox notification subscription.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateWorkflowUserInboxSubscription

Element Name	Element Type	Restrictions	Description
■ parameters
□ Custom		nillable	Custom key/value pairs associated with the subscription. Only strings and integers are supported as values. No nested objects or arrays.
□ EventFilter		nillable	Filter the generated events before sending them. In this way you can ignore events you are not interested in.
□ Whitelist		nillable	Filter the generated events before sending them. In this way you can ignore events you are not interested in.
≡ WSEventItem		list nillable
■ EventType	xs:int	mandatory	The event type of the notification (specified in 'NotificationType') that is generated.
■ NotificationType	xs:int	mandatory	The notification type that the subscription might generate.
□ Mobile		nillable	Mobile mechanism configuration
□ DeviceId	xs:string	mandatory nillable	Unique device token to identify where the notifications should be sent.
□ Options		nillable	Custom key/value pairs associated with WSMobileMechanism. Only strings and integers are supported as values. No nested objects or arrays.
≡ WSMobileOptionItem		list nillable
□ Key	xs:string	mandatory nillable	Unique key value.
□ Value	xs:string	mandatory nillable	Option value
□ Pull		nillable	Pull mechanism configuration
□ Webhook		nillable	Webhook mechanism configuration
■ AddTextMessage	xs:boolean		If a text representation of the message should be added. The default is false.
■ ExpiryOption		restriction enum (xs:string) - TimeBased (0) - ErrorBased (1)	The expiry option for the subscription. 0 = Time-based subscription which you have to refresh. 1 = Error-based removal, does not expire on time.
□ WebhookUrl	xs:string	mandatory nillable	The Webhook URL, where the notifications should be sent to.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/CreateWorkflowUserInboxSubscriptionResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ Id	xs:string	nillable	The Id of the created subscription

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.