Changelog¶

Version 1.6¶

v1.6.8 October 10, 2018¶

Property defaultEmblemThumbnailUrl added to Group resource

v1.6.7 August 21, 2018¶

API supports custom network domains

v1.6.6 July 18, 2018¶

Property numVideoViews added to Message resource

v1.6.5 June 5, 2018¶

Links will not override properties with the same name

v1.6.3 March 15, 2018¶

Property responsive added to App Manifest resource

Version 1.5¶

v1.5.9 December 14, 2017¶

Property numUnrespondedEvents added to Badge counter resource

v1.5.7 October 24, 2017¶

A network is no longer limited to having a single white label app
HAL whitelabelApps relation added to Network resource
HAL networks relation added to Whitelabel App resource
Read-only property numNetworks added to Whitelabel App resource
Property platform added to Whitelabel App resource
Introduced Platform enum with values android and ios
Property downloadUrl added to Whitelabel App resource
Introduced Network Identity object

v1.5.6 October 12, 2017¶

Deprecated property appStoreUrl from Whitelabel App Resource
Deprecated property googlePlayUrl from Whitelabel App Resource
Property addedRecipients added to Message resource (in write-context)
Property removedRecipients added to Message resource (in write-context)
Read-only property reason added to Bubble object
Introduced Bubble Reason enum
Bubbled updates now contain a reason that indicates why bubbling took place. Up until this version new_comment was the only reason for an update to bubble.
Editing event can cause it to bubble up. Three separate reasons were added for this: date_time_changed, location_changed and details_changed

v1.5.5 September 28, 2017¶

Introduced GET collection endpoint on past User Devices subresource
HAL account relation added to User resource (for authorized clients only)
Deprecated property whitelabelApp from Network Resource (write-context)
Property appVersion added to UserDevice resource
Property appDistributorEnabled added to Network resource
Introduced event_details_changed alert type
Introduced app-distributor App Position

v1.5.4 September 14, 2017¶

Introduced event_details_changed alert type

v1.5.3 August 31, 2017¶

Introduced event_invitation, event_canceled, event_date_time_changed, event_location_changed alert types
New invitees to a private event now receive an alert
Invitees of a private event will now receive an alert when the date/time and/or its location have been changed
Introduction of a custom error code -38: invalid date range

v1.5.2 August 17, 2017¶

Introduced event editing
Introduced POST and PUT update endpoints on Events resource
Introduced GET collection endpoint on past Events subresource
Property eventHeaderBackgroundUrl added to Network Theme subresource
Introduced event_header_background file type
Bug: news addressees no longer include suspened users
Bug: fixed property whitelisting issue related to null values

v1.5.1 August 3, 2017¶

Introduced event cancelation and reactivation
Introduction of cancel and reinstate permissions on Message resources
Introduced cancel and reinstate action endpoints on Message resource
Read-only property canceled added to Event object of Message resource

v1.5.0 June 15, 2017 - 20 July, 2017¶

Introduced event message type
Introduced Event object
Introduced GET collection endpoint on Message (type event) resource
Query filter tz introduced for the Message (type event) resource collection
Introduction of rsvp permission on Message resources
Introduced rsvp action endpoint on Message resource
HAL rsvp relation added to Message (type event) resource
Introduced Invitation Response (i.e. RSVP) enum
Read-only property responderCounts added to Event object of Message resource
Property rsvp added to user metadata of Message (type event) subresource
Property rsvp added to metadata of User resource

Version 1.4¶

v1.4.8 May 31, 2017¶

From now no all different Network Administrator roles (e.g. enterprise_admin) will be returned as admin in the Role, and Membership resource and user metadata of the Network resource
Property favicon added to Network resource (in write-context)
HAL favicon relation added to Network resource
Renamed property event in the Message Resource to announcement
Property fallbackUrl added to App Entry Point object.
The fallback URL may contain an alternative location for devices that cannot handle the regular entry point URL

v1.4.7 May 18, 2017¶

Introduced host-info endpoint
Read-only property speakapDomain added to Network resource
Read-only property baseUrl added to Network resource
HAL hostInfo relation added to Network resource

v1.4.5 April 5, 2017¶

Introduced GET collection endpoint on Message Addressees subresource
Read-only property numReaders added to Message resource
Authors of news items and users with administrative privileges over any of the recipients are able to view the readers of news
Introduced Email Settings resource
Introduced POST and PUT update endpoints on Email Settings resource
Read-only property emailSettings added to Network resource
Incoming links to Speakap can now include an Identity Provider (idp) parameter. This will cause an immediate redirect to the relevant authentication service

v1.4.4 March 9, 2017¶

Property urlAppendNetwork added to App Entry Point object
Apps that have the abovementioned property added to external entry points of their manifest will get two query parameters appended to SSO redirect URIs: network_eid and network_auth_url

v1.4.3 February 23, 2017¶

Introduction of like permission on Message resources
Updates and news items can be locked from now on. Locked messages and their comments cannot be liked nor can they be commented on any longer
Property locked added to Message resource
Uncommentable messages will have their numComments and numLikes properties set to 0
The HAL resource of uncommentable messages will no longer have comments and/or likers relations
Group memberships that are “externally managed” will be protected from deletion by Speakap administrators. Externally managed means that third-party HR-software dictates the creation and removal of these kind of memberships
Read-only property lockedBy added to Membership object of groups
Property lockedBy added to membership metadata of User Groups subresource

v1.4.2 February 14, 2017¶

Bug: fixed sending app alerts to multiple user recipients

v1.4.1 January 12, 2017¶

All group managements permissions are now transitive: network administrators can manage all groups, group administrators can manage all subgroups
Query filter permission introduced for the Group resource collection
Whitelisted dimensions for on demand thumbnails: 390x170, 300x170 and Wx270

v1.4 December 1, 2016¶

Introduced various video thumbnail formats
Added HLS, DASH and video to file display previews of streaming video
Introduction of uploading and streaming video
Introduced video stream playback endpoint on File Resource
Introduced GET video stream endpoint on File Resource
For updates in write context files need to be attached in the category corresponding to their file type
Read-only property numImages added to Message resource
Read-only property numVideos added to Message resource
Read-only property numFiles added to Message resource
Property images added to Message resource (in write-context)
Property videos added to Message resource (in write-context)
Property files added to Message resource (in write-context)
Read-only property videoEnabled added to Network resource
Read-only property marketEnabled added to Network Features subresource
Introduced video_processing_complete alert type
HAL images relation added to Message resource
HAL videos relation added to Message resource
HAL files relation added to Message resource

Version 1.3¶

v1.3.8 October 18, 2016¶

Property hasMenuItem added to App Entry Point object
Applications can send alerts to users by targeting their XID
Alerts can now be sent to users with a pending invitation

v1.3.7 September 29, 2016¶

Property headerBackgroundUrl of the User resource no longer returns a thumbnail, but the URL of the original image
HAL organizationGroups relation added to User resource
Introduced internal contact label type
Introduced various thumbnail formats

v1.3.6 September 19, 2016¶

Introduced whitelist for thumbnails that are generated on demand
Users can now hide their primary email address
Read-only property hidden added to Email Address object
Property defaultPrimaryEmailPrivacySetting added to Network object
Introduced File Dimensions object
Property dimensions added to File object of Message resource

v1.3.4 - v1.3.5 September 5, 2016¶

Introduced different timeline sorting options
Introduced Preferences object
Property preferences added to User Settings subresource

v1.3.3 July 28, 2016¶

Deprecated Usage resource

v1.3.2 July 14, 2016¶

Introduced subscribe action endpoint on Message resource
Introduced unsubscribe action endpoint on Message resource
Property widgetHeight added to App Entry Point object

v1.3.1 June 30, 2016¶

Property subscribed added to user metadata of Message resource
Introduced message_activity_comment alert type

v1.3 June 16, 2016¶

Introduces editing updates and comments
Property superseded added to Message resource

Version 1.2¶

v1.2.2 April 29, 2016¶

Deprecated non-standard HTTP status texts in JSON error response

v1.2.1 March 24, 2016¶

Introduced DELETE by XID endpoint on User resource
Introduced suspend action endpoint on Membership resource
Suspended users are reactivated when reinvited

v1.2 March 10, 201z¶

Introduced accept Terms of Service action endpoint
Introduction of SAML Signle Sign On
Introduced Access Preconditions object
Property identity added to Ivitee object
Property autoActivate added to Ivitee object
Introduced Identity object
Property accessPreconditions added to user metadata of Network resource
Introduced reactivate Network Invite Result type
Introduced Single Sign On object
Property sso added to Network resource (in write-context)

Version 1.1¶

v1.1.16 January 28, 2016¶

Both published news items and drafts returned in news collection
Property whitelabelApp added to User Device resource

v1.1.15 December 17, 2015¶

Changed default timezone format (colon introduced between hours and minutes)
Application permission list_group_members added
Application permission list_networks added

v1.1.14 December 7, 2015¶

Introduced GET collection endpoint on Whitelabel App resource
Introduced GET endpoint on Whitelabel App resource
Introduced POST new endpoint on Whitelabel App resource
Introduced PUT update endpoint on Whitelabel App resource
Introduction of the rich news editor
Property whitelabelApp added to App Manifest resource (in write-context)
Read-only property lastModified added to Message resource
Read-only property lastEdited added to Message resource
HAL lastEditoroMes relation added to Message resource
Property status added to Message resource
Property htmlBody added to Message resource
Property headerBackground added to Message resource (in write-context)
Read-only property headerBackground added to Message resource
HAL headerBackground relation added to Message resource
Read-only property newsHeaderBackground added to Network Theme resource

v1.1.13 October 29, 2015¶

Application permission get_network_timeline added

v1.1.12 October 15, 2015¶

Introduced DELETE endpoint on Sessions resource
Introduced resolvelocation action endpoint
Introduced resolvelocation action endpoint
Introduced GET collection endpoint on Sessions resource
Introduced POST update endpoint on Sessions resource

v1.1.11 October 1, 2015¶

Introduced GET collection endpoint on Group Widgets subresource
Introduced POST bulk update endpoint on Group Widgets subresource
Introduced PUT bulk update endpoint on Group Widgets subresource
Introduction of group widgets

v1.1.10 September 17, 2015¶

Introduced GET endpoint of Spotlight Widget on Group Resource
Introduced POST update endpoint of Spotlight Widget on Group Resource
Renamed property type to widgetType in Widget Resource
Property type added to Widget resource
Property XID added to Group resource
Property membersMayPost added to Group resource
Property recipients added to Share entity

v1.1.9 September 7, 2015¶

Application permission get_user_groups added
Application permission post_to_any_group added
Introduced DELETE endpoint on Alert resource
Introduced POST update endpoint on Alert resource
Property emailDeliveryFormat added to Network subresource

v1.1.8 July 28, 2015¶

Application permission get_profile_xid added
Application permission list_groups added
Introduced DELETE endpoint on User Authorized Apps subresource
Introduced GET by XID endpoint on User resource
Introduced GET collection endpoint on User Authorized Apps subresource
Introduced PATCH endpoint on User resource
Introduced POST new endpoint on User Authorized Apps subresource
Introduced POST update by XID endpoint on User resource
Introduced POST update endpoint on User Authorized Apps subresource
Introduction of Single Sign On for Speakap applications
Property redirectUris added to Group resource
Property scope added to user metadata of App resource
Property authorized added to user metadata of App resource

v1.1.7 July 9, 2015¶

Query filter label introduced for the Group resource collection
Query filter q introduced for the Label resource collection
Introduced DELETE endpoint on Label resource
Introduced GET collection endpoint on Label resource
Introduced GET endpoint on Label resource
Introduced POST new endpoint on Label resource
Introduced POST update endpoint on Label resource
Introduced PUT update endpoint on Label resource
Introduced label recipients
Introduced Label resource

v1.1.6 June 26, 2015¶

Application permission list_network_roles added
Query filter exclude_group introduced for the User resource collection
Read-only property total added to Pagination object

v1.1.5 June 11, 2015¶

Application permission upload_into_folders added
Query filter ancestor introduced for the Group resource collection
Read-only property created added to successful JSON response

v1.1.4 April 30, 2015¶

Deprecated property relationshipStatus from User Resource

v1.1.3 April 16, 2015¶

Introduced sync-user action endpoint of Network resource
Property XID added to User resource

v1.1.2 April 2, 2015¶

Query filter addable_to introduced for the User resource collection

v1.1.1 March 19, 2015¶

Query filter addressable_for introduced for the Group resource collection
Group’s name is not longer appended with the parent group name

v1.1 March 5, 2015¶

Introduction of Enterprise Speakap
Application permission infinite_limit added
Query filter disable_participant_matching introduced for the Conversation resource collection
Query filter include_hidden introduced for the Group resource collection
Query filter parent introduced for the Group resource collection
Query filter scope introduced for the Group resource collection
Query filter type introduced for the Group resource collection
Query filter scope introduced for the User resource collection
Introduced GET collection endpoint on Group Types subresource
Introduced GET endpoint on Group Types subresource
Introduced GET collection endpoint on Group Relations subresource
Introduced POST new endpoint on Business Unit resource
Introduced POST new endpoint on Department resource
Introduced POST new endpoint on Group Relations subresource
Introduced POST update endpoint on Group Types subresource
Introduced POST new endpoint on Group Relations subresource
Introduced POST new endpoint on Group Types subresource
Introduced add action endpoint on Group Users subresource
Introduced merge action endpoint on Group Users subresource
Introduced POST new endpoint on Local Department resource
Introduced POST update endpoint on Network Subscription subresource
Introduced PUT update endpoint on Group Types subresource
Introduced PUT update endpoint on Network Subscription subresource
Property parent added to Group resource (in write-context)
HAL parentGroup relation added to Group resource
HAL subgroups relation added to Group resource
Read-only property hidden added to Group resource
Introduced Business Unit resource
Introduced Department resource
Introduced Local Department resource
Introduced Group Role entity
Introduced Group Relation resource
Introduced user and group cover images
Property groupHeaderBackgroundUrl added to Network Theme subresource
Property userHeaderBackgroundUrl added to Network Theme subresource
Read-only property group:basic added to search result metadata
Read-only property group:business_unit added to search result metadata
Read-only property group:any_department added to search result metadata
Read-only property message:file:document added to search result metadata

Version 1.0¶

v1.0.25 - v1.0.26 December 18, 2014¶

Query filter role introduced for the Group resource collection
Introduced GET collection endpoint on Group Users subresource
Introduced GET collection endpoint on Message Recipients subresource
Introduced GET collection endpoint on News Recipients subresource
Property privacy added to User Settings subresource
Read-only property numRecipients added to Message resource
Property permissions added to user metadata of Message resource

v1.0.24 November 20, 2014¶

Introduced GET collection endpoint on Alert Groups subresource
Introduced GET collection endpoint on Alert Originators subresource
Introduced GET collection endpoint on User Groups subresource
Introduced add action endpoint on User Groups subresource
Introduced remove action endpoint on User Groups subresource
Introduced added_to_groups alert type
Introduced removed_from_groups alert type
Read-only property numGroups added to Alert resource
Introduced Folder Name object
Read-only property hasSubFolders added to File entity
Read-only property path added to File entity

v1.0.22 - v1.0.23 November 5, 2014¶

Application permission edit_network_features added
Application permission edit_network_subscription added
Introduced GET endpoint for default Group emblems
Deprecated GET roster endpoint of Presence resource
Introduced GET conversation roster endpoint of Presence resource
Introduced GET others roster endpoint of Presence resource
Introduced downgrade action endpoint on Network resource
Introduced upgrade action endpoint on Network resource
Introduced POST update endpoint on Network Features subresource
Introduced PUT update endpoint on Network Features subresource
Introduced external users
Read-only property hasExternalMembers added to Group resource
Read-only property extrnal added to User resource
Property role added to Invitee List entity
Property groups added to Invitee List entity (in write-context)
Introduced applications events
Property events added to App Manifest resource
Introduced App Manifest Events object
Read-only property hasExternalMembers added to Network resource
Property localLabel added to App Entry Point object
Property localName added to App Manifest resource
Read-only property default added to Role resource

v1.0.20 - v1.0.21 September 11, 2014¶

Application permission get_profiles added
Introduced GET endpoint for default User avatars
Introduced GET roster endpoint of Presence resource
Introduced GET endpoint of User Presence subresource
Introduced presence action endpoint on Network resource
Introduced presence feature
Introduced Presence resource
Property lightboxTemplate added to App Entry Point object
Property role added to signed requests

v1.0.19 August 14, 2014¶

Introduced GET collection endpoint for recent files
Introduced mentioning of users
Introduced Mention entity
Introduced mention alert type
Property mentions added to Message resource

v1.0.18 July 31, 2014¶

Application permission upload_files added
Introduced GET endpoint of avatar mosaics
Introduced announcement message type
Property title added to Conversation resource
Property icon added to Conversation resource (in write-context)
Read-only property iconThumbnailUrl added to Conversation resource
Introduced orphaned_group alert type
Introduced Announcement Event Type enum
Read-only property data added to Message resource
Read-only property event added to Message resource
HAL participants relation added to Message resource

v1.0.17 July 17, 2014¶

Introduced GET collection endpoint on Conversation Participants subresource
Introduced temporary action endpoint on File resource
Introduced crop action endpoint on Message resource
Introduced Embedly support
Introduced Embed URL entity
Property embeds added to Message resource
Read-only property numParticipants added to Conversation resource

v1.0.16 July 3, 2014¶

Query filter commented introduced for the User resource collection
Introduced DELETE endpoint on Membership resource
Introduced GET collection endpoint on Message Commenters subresource
Introduced GET collection endpoint on Message Likers subresource
Introduced meta action endpoint for Embedly URLs
Introduced GET endpoint on User New Features subresource
Introduced like action endpoint on Message resource
Introduced unlike action endpoint on Message resource
Introduced POST update endpoint on User New Features subresource
Read-only property numAttachments added to Message resource
Read-only property numLikes added to Message resource
Property hasRecentlyCommented added to user metadata of Message resource
Property hasLiked added to user metadata of Message resource
Read-only property numOriginators added to Alert resource
HAL originators relation added to Alert resource

v1.0.15 June 5, 2014¶

Introduced remove action endpoint on App resource
Introduced move action endpoint on Message resource
Introduced remove action endpoint on Message resource
Property parentFolder added to Message resource (in write-context)
HAL parentFolder relation added to Message resource
Introduced User Features subresource
Deprecated property numAuthors from Alert Resource

v1.0.14 May 22, 2014¶

Introduced add action endpoint on App resource
Introduced read action endpoint on Message resource
Introduced PUT update endpoint on Message resource
Read-only property removable added to App Manifest resource
Read-only property message:file:folder added to search result metadata
Read-only property name added to File entity
Read-only property extension added to File entity

v1.0.13 May 8, 2014¶

Query filter exclude_role introduced for the Membership resource collection
Query filter modified_since introduced for the Conversation resource collection
Query filter modified_since introduced for the Group resource collection
Query filter modified_since introduced for the User resource collection
Introduced Network Features subresource
Read-only property marketEnabled added to Network resource
Read-only property lastModified added to User resource
Read-only property lastModified added to Group resource

v1.0.12 May 1, 2014¶

Query filter exclude_role introduced for the User resource collection
Introduced DELETE endpoint on Role resource
Introduced GET endpoint on User Device resource
Introduced GET collection endpoint on Role resource
Introduced GET default endpoint on Role resource
Introduced GET endpoint on Role resource
Introduced POST new endpoint on Role resource
Introduced POST update endpoint on Role resource
Introduced PUT update endpoint on Role resource
Introduced changeroles action endpoint on Network resource
Introduced merge action endpoint on User resource
Introduced network roles
Introduced Role resource

v1.0.11 March 21, 2014¶

Query filter coalesced introduced for the Alert resource collection
Introduced POST update endpoint on User Settings subresource
Introduced bubbling in timelines
Introduced Bubble object
Property bubble added to Message resource
Introduced alert coalescing
Property numCoalesced added to Alert resource
Property numAuthors added to Alert resource
Property numAuthors added to Alert resource
Property numUnreadAlertsCoalesced added to Badge counter resource

v1.0.10 February 20, 2014¶

Deprecated GET endpoint of Widget resource
Introduced GET endpoint of Spotlight Widget
Introduced GET collection endpoint on Widget resource
Introduced GET collection endpoint on User Settings subresource
Deprecated POST update endpoint of Widget resource
Introduced POST update endpoint of Spotlight Widget
Introduced POST bulk update endpoint on Widget resource
Introduced PUT bulk update endpoint on Widget resource
Introduced PUT update endpoint on User Settings subresource
Property tourCompleted added to User resource
Property appData added to Message resource
Header X-File-Name will be properly URL decoded
Property appData added to Alert resource
Introduced User Settings subresource
Read-only property invitedAt added to Membership resource

v1.0.9 February 6, 2014¶

Application permission send_alerts added
Introduced GET endpoint on User Status subresource
Property message added to Invitee List entity
Property iconThumbnailUrl added to App Manifest resource
HAL app relation added to Alert resource
Introduced Widget resource

v1.0.8 January 17, 2014¶

Application permission post_updates added
Introduced app_update message type
Property recipients added to Message resource (in write-context)
Property resend added to Invitee List entity
Property invitees added to Invitee List entity
Introduced Invitee object
HAL app relation added to Message resource

v1.0.7 January 16, 2014¶

Application permission invite_users added
Introduced GET collection endpoint on Badge Counter resource
Deprecated markread action endpoint of Conversation resource
Property permissions added to App Manifest resource
Property recipients added to Message resource (in write-context)

v1.0.6 January 8, 2014¶

Query filter include_secret introduced for the Group resource collection
Introduced GET endpoint on App resource
Introduced GET collection endpoint on App Manifest resource
Introduced GET collection endpoint on Network resource
Introduced GET collection endpoint on App resource
Introduced GET branding CSS on Network resource
Introduced signrequest action endpoint on App Manifest resource
Introduced POST new endpoint on App resource
Introduced POST update endpoint on App resource
Introduced checkexistence action endpoint on Resource resource
Property locale added to signed requests
Property device added to signed requests
Property position added to signed requests
Property appData added to signed requests
Introduced App resource
Introduced App Manifest resource
Introduced App Entry Point object
Introduced Audience object
Introduced App Position enum
Introduced app alert type

v1.0.5 December 11, 2013¶

Introduced GET endpoint on Token resource
Introduced changepassword action endpoint
Introduced POST new endpoint on User Device resource
Deprecated markread action endpoint of Alert resource
Deprecated changepassword action endpoint of User resource
Introduced User Device resource
Introduced Token Status resource
Property member added to user metadata of Network resource
Introduced Resource List resource

v1.0.4 November 13, 2013¶

Introduced share action endpoint on Message resource
Property language added to Network resource
Read-only property deleted added to User resource
Read-only property message:news added to search result metadata
Property loginBackgroundUrls added to Network Theme subresource

v1.0.3 November 7, 2013¶

Query filter role introduced for the User resource collection
Introduced GET endpoint on Widget resource
Introduced GET collection endpoint on default backgrounds
Introduced POST update endpoint on Widget resource
Introduced POST new endpoint on Network Theme subresource
Introduced Network Theme subresource
Property theme added to Network resource

v1.0.2 October 23, 2013¶

Query filter category introduced for the Alert resource collection
Query filter invitee introduced for the Group resource collection
Query filter role introduced for the Membership resource collection
Introduced DELETE endpoint on Group resource
Deprecated GET endpoint of Network Invites subresource
Deprecated GET collection endoint of Network Invites subresource
Introduced generic action endpoint on Alert resource
Introduced changepassword action endpoint on User resource
Introduced invite action endpoint on Group resource
Query filter category introduced for the Alert resource collection
Read-only property data added to successful JSON response
Property numAdminALerts added to Badge counter resource
Read-only property category added to Alert resource
HAL group relation added to Alert resource