Notify publishedApplication

POST

/v1/integrations/distributions/:publishedApplicationId/notify

Notify publishedApplication

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

publishedApplicationId string

required

Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json

configuration object required

Notification targeting configuration defining recipient groups and filtering criteria for selective communication about build availability.

notifyCollaborators boolean required

Boolean flag indicating whether application collaborators should receive notifications for this event, enabling selective communication based on user roles.

notifyEmployees boolean required

Boolean flag indicating whether organization employees should receive notifications for this event, enabling broad internal communication.

filter array [array] required

Group-based filtering criteria using nested arrays where inner arrays represent OR conditions and outer array represents AND conditions for targeted notifications.

language any required

Language code for notification localization determining email template, subject line, and content language for internationalized communications.

emailText any optional

Custom email body content in plain text or HTML format for personalized notification messages beyond default templates.

emailSubject any optional

Custom email subject line for notification messages, replacing default subject with context-specific information.

userAudienceIds array [string] optional

Array of user audience identifiers for targeting specific pre-defined user segments with build notifications instead of general collaborator or employee groups.

{
    "configuration": {
        "notifyCollaborators": true,
        "notifyEmployees": true,
        "filter": [
            [
                "string"
            ]
        ]
    },
    "language": "en",
    "emailText": "string",
    "emailSubject": "string",
    "userAudienceIds": [
        "string"
    ]
}

Responses

200 Response application/json

status boolean required

data object required

done boolean required

{
    "status": true,
    "data": {
        "done": true
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}