App Webhook Endpoints
Update App Version Information
POST https://connect.sidestore.io/api/webhook/apps/APP_ID/version/VERSION_NUMBER
POST https://connect.sidestore.io/api/webhook/apps/APP_ID/version/VERSION_NUMBER
This endpoint can be used to create new app versions, update the version descriptions in multiple languages and set an external download url and download file size of the new or an existing version. The version can also be published through this endpoint.
Parameters
APP_ID
: The bundle identifier of the app for which the description should be updatedVERSION_NUMBER
: The version number for which the information should be updated. If a new version should be created, theVERSION_NUMBER
has to be higher than the current version of the app in SideStore Connect and the valueallowCreateNewVersion
has to be set totrue
.
Headers
Authorization
:Bearer ACCESS_TOKEN
Body (JSON)
allowCreateNewVersion
(optional)
Aboolean
controlling wether a new version should be created if theVERSION_NUMBER
doesn't match any of the available versions of the app with the bundle identifierAPP_ID
. Default:false
.versionDescription
(optional)
Adict
containing a new app version description for every enabled language with the language code as the key and the description text as the value.externalDownloadUrl
(optional)
Astring
containing the url to download the app build that is hosted outside of SideStore Connect. If this value is set, thedownloadFileSize
has to be present as well.downloadFileSize
(optional)
The app build file size as anumber
. Required in conjunction withexternalDownloadUrl
.publish
(optional)
Aboolean
indicating wether the versionVERSION_NUMBER
should be published after all changes have been applied. This will make the version instantly available to all SideStore users with the SideStore Connect instance in their sources. Default:false
Upload New App Build
POST https://connect.sidestore.io/api/webhook/apps/APP_ID/version/VERSION_NUMBER/upload_build
POST https://connect.sidestore.io/api/webhook/apps/APP_ID/version/VERSION_NUMBER/upload_build
This endpoint can be used to upload a new build for a version of an app. The build has to be a valid IPA file.
Parameters
APP_ID
: The bundle identifier of the app for which the description should be updatedVERSION_NUMBER
: The version number for which the information should be updated. If a new version should be created, theVERSION_NUMBER
has to be higher than the current version of the app in SideStore Connect and the valueallowCreateNewVersion
has to be set totrue
.
Headers
Authorization
:Bearer ACCESS_TOKEN
Body (Multipart-Data)
files.build
The data of the IPA file.