API Endpoints

These are the endpoints available for Front End integration with On Site Notifications and Rich Inbox. These endpoints are returning data for logged in users.

Getting the config and authenticating the user

get

https://am-events-[env].fasttrack-solutions.com/api/v1/config/[brand]

Get config

This endpoint returns needed config values for your brand

Parameters

path

brand *
String
Your "Fast Track Brand Name" given to you by the Integration Manager
env *
String
Current environment, can be staging or nothing which means production.

Responses

200: OK

post

[FUSION_URL]/Platform/LoginAuthToken

Authenticate

The login endpoint which exchanges the sid / auth token for a user object.

Parameters

header

authtoken *
String
The sid / auth token to authenticate the user with

Responses

200: OK

get

[FUSION_API]/external/pusher/[brand]?authToken=[sid]

Authenticate against Pusher

This endpoint is usually consumed by the Front End Pusher Javascript SDK.

Parameters

query

authToken *
String
The sid / auth token to authenticate the user with

path

brand *
String
Your "Fast Track Brand Name" given to you by the Integration Manager

Responses

200: OK

Consuming the data

get

[FUSION_URL]/Notifications/v2/user-notifications

Get all notifications

Lists all notifications for the authenticated user. Use the query string parameters to filter notifications.

The DisplayType can be used to send silent inbox notifications. There is a checkbox in the CRM for silent notifications.

Parameters

query

unread-only *
boolean
Only return unread notifications

header

authtoken *
String
sid / auth token for currently logged in user.

Responses

200: OK

get

[FUSION_URL]/Notifications/v2/user-notification/[id]

Get specific notification

Returns a specific notification for the authenticated user. Pass the message id in the url.

Parameters

path

id *
Integer
The id of the message to retrieve

header

authtoken *
String
sid / auth token for currently logged in user.

Responses

200: OK

delete

[FUSION_URL]/Notifications/v2/user-notification/[id]

Delete Rich Inbox Message

Deletes a Rich Inbox Message for the authenticated user. So that the message is not returned again on API.

Parameters

path

id *
Integer
The id of the message to delete

header

authtoken *
String
sid / auth token for currently logged in user.

Responses

200: OK

post

[FUSION_URL]/Notifications/MarkNotificationAsRead

Mark a notification as read

Marks On Site Notification or Rich Inbox message as read for authenticated user

Parameters

body

MessageId *
Integer
The id of the message to be marked as read

header

authtoken *
String
sid / auth token for currently logged in user.

Responses

200: OK

Client Side Flow

Native Push Notifications

Contents Getting the config and authenticating the user Consuming the data

Learn how to integrate the Fast Track platform

A manual on how to use our different features

Best practices and practical examples on how to do stuff

API Endpoints

Getting the config and authenticating the user

Get config

Parameters

path

Responses

Authenticate

Parameters

header

Responses

Authenticate against Pusher

Parameters

query

path

Responses

Consuming the data

Get all notifications

Parameters

query

header

Responses

Get specific notification

Parameters

path

header

Responses

Delete Rich Inbox Message

Parameters

path

header

Responses

Mark a notification as read

Parameters

body

header

Responses