Upsource API Documentation Index

Messages

View as JSON

M AchievementDTO

FieldTypeLabelDescription
id string required
Achievement ID
name string required
Achievement title
shortDescription string required
Short description of the achievement
description string optional
Longer description of the achievement
date int64 optional
Unix timestamp of the unlocking event
isUnread bool optional
Whether the user saw a notification about the unlocking
isUnlocked bool optional
Whether the achievement is unlocked by the user

M AchievementsListDTO

FieldTypeLabelDescription
items AchievementDTO repeated

M CheckCanCreateProjectRequestDTO

FieldTypeLabelDescription
hubProjectId string required
Hub project ID

M CheckCanCreateProjectResponseDTO

FieldTypeLabelDescription
isAllowed bool required
Whether the user has the right to create projects
message string optional
Optional text message

M EmailBouncesResponseDTO

FieldTypeLabelDescription
emails string repeated
Emails with either a "soft bounce" or a "hard bounce" status

M ExportDataResponseDTO

FieldTypeLabelDescription
serverPath string required
A full path to the server

M GetProjectSettingRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
request GetSettingRequestDTO required
See GetSettingRequestDTO parameters

M GetSettingRequestDTO

FieldTypeLabelDescription
key string required
Setting key

M GetSettingResponseDTO

FieldTypeLabelDescription
value string optional
User setting value

M ProjectWebhookTriggerDTO

FieldTypeLabelDescription
events WebhookEventEnum repeated
Events to be notified of
urls string repeated
URL targets for webhook requests

M ReadOnlyModeDTO

FieldTypeLabelDescription
isReadOnly bool required
Whether the server is in read-only mode
description string optional
Describes the reason for enabling read-only mode (if any)

M SetMottoRequestDTO

FieldTypeLabelDescription
motto string optional
Server motto text (leave empty to remove an existing one)

M SetProjectSettingRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
request SetSettingRequestDTO required
See SetSettingRequestDTO parameters

M SetProjectWebhooksRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
triggers ProjectWebhookTriggerDTO repeated
List of webhook triggers

M SetSettingRequestDTO

FieldTypeLabelDescription
key string required
Setting key
value string required
Setting value

M TestPOP3MailboxRequestDTO

FieldTypeLabelDescription
protocol string required
Protocol type ("POP3", "POP3+SSL", "POP3+TLS")
host string required
Email service host name
port int32 required
Email server port number
login string required
Email login
password string required
Email password

M TestPOP3MailboxResponseDTO

FieldTypeLabelDescription
status TestPOP3MailboxStatusEnum required
Mailbox status. OK (1); LoginFailed (2); ConnectionFailed (3);
message string optional
Optional text message

M UpdateUserTimezoneDTO

FieldTypeLabelDescription
userId string required
User ID in Upsource
timezoneOffset int32 required
Timezone offset

M UserAchievementsCountDTO

FieldTypeLabelDescription
count int32 required

M UserAchievementsRequestDTO

FieldTypeLabelDescription
userId string required
User ID in Upsource

M UserActionNotificationDTO

FieldTypeLabelDescription
userId string required
User ID in Upsource

M UserAgreementTextDTO

Text of the end user agreement
FieldTypeLabelDescription
text string required

Enums

View as JSON

E TestPOP3MailboxStatusEnum

Describes connection status
NameNumberDescription
OK 1
LoginFailed 2
ConnectionFailed 3

E WebhookEventEnum

NameNumberDescription
CommentAdded 1
On comment added
ReviewCreated 2
On review created
ReviewParticipantCompleted 3
On review accepted or concern raised
NewReviewParticipant 4
On new review participant
RevisionAddedToReview 5
On revision added to review
NewRevision 6
On new revision
ReviewStateChanged 7
On review closed or reopened
ReviewParticipantRemoved 8
On review participant removed
MergedToDefaultBranch 9
On merge to the default branch
NewBranch 10
On new branch
ReviewRemoved 11
On review removed
BranchRemoved 12
On branch removed
ReactionToggled 13
On reaction added or removed
CommentEdited 14
On comment edited
CommentRemoved 15
On comment removed
ReviewLabelChanged 16
On review label added or removed