Skip to content

Pushwoosh Outsystems plugin client actions

The Plugin provides a set of client actions to facilitate push notification management. These actions allow you to register and unregister devices, set and get tags, manage inbox messages, and more.

Pushwoosh plugin client actions

Anchor link to

CheckPushwooshPlugin

Anchor link to

Validates if the Pushwoosh plugin is currently available.

Output parameters

Anchor link to
IsAvailableReturns true if the plugin is available to use, false otherwise
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

Usage example

Anchor link to
CheckPushwooshPlugin action

RegisterDevice

Anchor link to

Registers a device for push notifications and retrieves a Push Token.

Input parameters

Anchor link to
ApplicationCodeText, the Pushwoosh application code obtained from your account settings.

Output parameters

Anchor link to
RegisterTokenToken received from Google or Apple for the device
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

UnregisterDevice

Anchor link to

Unregisters a device from receiving push notifications.

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

GetDeviceID

Anchor link to

Retrieves the device ID, which should be a unique identifier.

Output parameters

Anchor link to
DeviceHwidThe unique identifier of the device.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when there was an error.

GetDeviceType

Anchor link to

Gets the Device Type (Android, iOS, or Windows).

Output parameters

Anchor link to
DeviceTypeIdThe identifier of this device type.

Fetches tags data from Pushwoosh.

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.
TagsReturns Key, Value Record List containing all tags assigned to this device.

Usage example

Anchor link to
  1. Invoke the GetTags action to fetch the tags data from Pushwoosh.
  2. The returned tags are accessible via the GetTags.Tags list.
  1. Use the LogMessage action to log each tag’s key and value.

Sends a message to Pushwoosh when a particular event in your application happens.

Input parameters

Anchor link to
EventNameText, name of the event
EventAttributesKey, Value Record List, used to send additional event data to Pushwoosh (i.e. for the “UserLogin” action you might want to send login data, such as - {“username”:“John”})

Output parameters

SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

Usage example

Anchor link to

1. Assign

Set up key-value pairs to define the data for the event. For instance, KeyValue1.AttributeName as “test1” and KeyValue1.Value as “test1value”. Similarly, define KeyValue2 with the appropriate attribute name and value.

2. Create lists of attributes to be associated with the event.

  1. Finally, configure the PostEvent action.

SetBadgeNumber

Anchor link to

Sets the application icon badge number.

Input parameters

Anchor link to
BadgeNumberInteger, Icon badge number.

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

SetLanguage

Anchor link to

Sets custom application language instead of the default system language.

Input parameters

Anchor link to
LanguageText, Custom application language in 2-letter ISO format (e.g., “en”, “es”, “fr”)

Sends tags and their values to Pushwoosh.

Input parameters

Anchor link to
TagsTagName, TagValue Record List containing all tags you want to send. TagName type should always be Text, while TagValue can be Text, Integer, Boolean, Date, etc.

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

Usage example

Anchor link to
  1. Assign tag values. In the example below, there are two tags:
  • Tag1 with a name testTag and its value set to the current date.
  • Tag2 with a name testTag2 and its value set to True.

2. Then, append tags to a list. In this example:

  • ListAppend3 adds Tag1 to the LocalTag list.
  • ListAppend4 adds Tag2 to the LocalTag list.

3. After populating the list with the necessary tags, use the SetTags client action to send this list to Pushwoosh.

Assigns a custom User ID to this device.

Input parameters

Anchor link to
UserIDText, custom User ID.

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

Pushwoosh Inbox Client Actions

Anchor link to

The process of working with Inbox is the following:

  1. Load a list of InboxMessage objects.
  2. Use these objects to render the inbox view.
  3. Perform the actions listed below, or delete these objects using the actions described below.
codeTextUnique ID of an inbox notification.
titleTextNotification title.
messageTextNotification message.
imageUrlTextURL of a custom image attached to a notification.
sendDate

Date

Time

Represents the time when a notification was sent.
typeInteger

Type of notification.

Possible values:

  • 0 - regular notification
  • 1 - rich media notification
  • 2 - URL notification
  • 3 - deep link notification
bannerUrlTextContains URL of an Android banner.
customDataKey, Value Record ListContains a list of parameters passed as custom data.
isReadBooleanTrue if inbox notification is read.
isActionPerformedBoolean
  • True if notification action is performed.
  • For regular notifications, true if a notification is read.
  • For Rich Media, true if rich media was presented.
  • For URL and deep links, true if URL/deep link was opened.

LoadMessages

Anchor link to

Fetches inbox notifications from Pushwoosh.

Output parameters

Anchor link to
InboxMessagesInboxMessage List, list of all inbox messages.
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

ReadMessage

Anchor link to

Marks the inbox message as read.

Input parameters

Anchor link to
MessageCodeText, code of an InboxMessage (received as a parameter of an InboxMessage in LoadMessages)

Output parameters

Anchor link to
SuccessTrue if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

PerformAction

Anchor link to

Performs action for specified inbox messages (e.g., open URL in a browser).

Input parameters

Anchor link to
MessageCodeText, code of an InboxMessage (received as a parameter of an InboxMessage in LoadMessages)

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

DeleteMessage

Anchor link to

Removes a message from inbox.

Input parameters

Anchor link to
MessageCodeText, code of an InboxMessage (received as a parameter of an InboxMessage in LoadMessages)

Output parameters

Anchor link to
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

TotalMessagesCount

Anchor link to

Returns the total number of inbox messages.

Output parameters

Anchor link to
MessagesCountInteger, total number of inbox messages.
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

UnreadMessagesCount

Anchor link to

Returns the number of unread inbox messages.

Output parameters

Anchor link to
UnreadMessagesCountInteger, number of unread inbox messages.
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.

MessagesWithNoActionPerformedCount

Anchor link to

Returns the number of inbox messages with no action performed.

Output parameters

Anchor link to
MessagesWithNoActionPerformedCountInteger, number of inbox messages with no action performed.
SuccessReturns true if everything goes as expected, false if there is an error.
ErrorAn error containing the error code and error message with details about any error that might have occurred. Only set when the Success output parameter is false.