Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

Therefore Web API > Web API Reference > Operations

CreateWorkflowUserInboxSubscription

Scroll

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.

 

 

© 2023 Therefore Corporation, all rights reserved.