category: Utilities sectionorder: - Connect - Collect provider: Bonusly commonfields: id: Bonusly version: -1 configuration: - defaultvalue: https://bonus.ly/api/v1/ display: Server URL (e.g. https://bonus.ly/api/v1/) name: url required: true type: 0 section: Connect - display: API Key name: api_key required: true type: 4 section: Connect - display: Incident type name: incidentType type: 13 required: false section: Collect - display: Incidents Fetch Interval name: incidentFetchInterval defaultvalue: '1' required: false type: 19 advanced: true section: Collect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect - display: Name of the specific Bonusly application (if required) name: application_name type: 0 required: false section: Connect - defaultvalue: '20' display: Max. number of bonuses to fetch (Default is 20) name: limit type: 0 required: false section: Collect - display: Filter by user email address (given and received) name: user_email type: 0 required: false section: Collect - display: Filter by hashtag (e.g., %23teamwork) name: hashtag type: 0 required: false section: Collect - defaultvalue: '1' display: Start fetching from X days ago (Defaults is 1 day) name: fetch_time type: 0 required: false section: Collect - display: Fetch incidents name: isFetch type: 8 required: false section: Collect description: The Bonusly integration is used to interact with the Bonusly platform through the API. Bonusly is an employee recognition platform which enterprises use to for employee recognition. display: Bonusly name: Bonusly script: commands: - arguments: - defaultValue: '20' description: 'Number of bonuses to retrieve (min: 1, max: 100) Default: 20.' name: limit - description: The start time by which to filter returned bonuses. e.g., 2015-10-28T21:26:50Z. name: start-time - description: The end time by which to filter returned bonuses, e.g., 2015-10-28T21:26:50Z. name: end-time - description: Email address of the bonus giver by which to filter results. name: giver-email - description: Email address of the bonus receiver by which to filter results. name: receiver-email - description: Email address of the bonus giver or receiver by which to filter results. this email. name: user-email - description: 'Filter to get a list of bonuses by a hashtag Example: %23teamwork.' name: hashtag - description: Whether to include child responses of the bonus. name: include-children - description: Whether to show private bonuses. Requires Admin API key. name: show-private-bonuses description: Gets a list of bonuses based on the supplied filters. name: bonusly-list-bonuses outputs: - contextPath: Bonusly.Bonus.id description: Bonus ID. type: String - contextPath: Bonusly.Bonus.created_at description: Date the bonus was created (given), e.g., 2015-10-28T21:26:50Z. type: Date - contextPath: Bonusly.Bonus.reason description: 'The bonus message, e.g., "For signing up for the world''s favorite employee recognition solution! #problem-solving".' type: String - contextPath: Bonusly.Bonus.reason_html description: HTML representation of the bonus. type: String - contextPath: Bonusly.Bonus.amount description: Number of points given in the bonus. type: Number - contextPath: Bonusly.Bonus.amount_with_currency description: Number and currency of points given in the bonus. type: String - contextPath: Bonusly.Bonus.value description: 'Hash tag included in the bonus, e.g., #problem-solving.' type: String - contextPath: Bonusly.Bonus.giver.id description: ID of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.short_name description: Short name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.display_name description: Display name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.username description: Username of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.email description: Email address of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.path description: URL path of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.full_pic_url description: URL path to the full picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.profile_pic_url description: URL path to the profile picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.first_name description: First name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_name description: Last name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_active_at description: Last time the bonus giver was active when available. type: Unknown - contextPath: Bonusly.Bonus.giver.external_unique_id description: Unique ID for the bonus giver (external). type: String - contextPath: Bonusly.Bonus.giver.budget_boost description: Whether a boost was given for the bonus. type: Number - contextPath: Bonusly.Bonus.giver.user_mode description: User mode of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.country description: Country where the bonus giver resides. type: String - contextPath: Bonusly.Bonus.giver.time_zone description: Timezone of the bonus giver, e.g., America/Los_Angeles. type: String - contextPath: Bonusly.Bonus.giver.*custom_property_name* description: Custom properties given in the bonus. type: String - contextPath: Bonusly.Bonus.giver.can_give description: Whether the giver can give bonuses. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance description: Available earning balance. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance_with_currency description: Earning balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.lifetime_earnings description: Lifetime earnings of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.lifetime_earnings_with_currency description: Lifetime earnings of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.can_receive description: Whether the bonus giver can receive bonuses. type: Boolean - contextPath: Bonusly.Bonus.giver.giving_balance description: Points balance of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance_with_currency description: Points balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.status description: Status of the bonus giver, e.g., archived. type: String - contextPath: Bonusly.Bonus.receiver description: Bonus receiver. type: Unknown - contextPath: Bonusly.Bonus.child_count description: Count of the child add-on bonuses. type: Number - contextPath: Bonusly.Bonus.via description: Bonus source, e.g., Web. type: String - contextPath: Bonusly.Bonus.family_amount description: Family bonus balance. type: Number - arguments: - description: The email address of the bonus giver. name: giver-email required: true - description: "The bonus message, e.g., \n+10 @george and @john for #execution with that customer #collaboration with the team, and #integrity on the known vulnerabilities to the application. \n\n+10 @francesco because he is fast and detailed\n." name: reason required: true - description: The parent bonus ID with which to associate this bonus, e.g., 24abcdef1234567890abcdef. name: parent-bonus-id description: Creates a Bonusly bonus. name: bonusly-create-bonus outputs: - contextPath: Bonusly.Bonus.id description: Bonus ID. type: String - contextPath: Bonusly.Bonus.created_at description: Date the bonus was created (given), e.g., 2015-10-28T21:26:50Z. type: Date - contextPath: Bonusly.Bonus.reason description: 'The bonus message, e.g., "For signing up for the world''s favorite employee recognition solution! #problem-solving".' type: String - contextPath: Bonusly.Bonus.reason_html description: HTML representation of the bonus. type: String - contextPath: Bonusly.Bonus.amount description: Number of points given in the bonus. type: Number - contextPath: Bonusly.Bonus.amount_with_currency description: Number and currency of points given in the bonus. type: String - contextPath: Bonusly.Bonus.value description: 'Hash tag included in the bonus, e.g., #problem-solving.' type: String - contextPath: Bonusly.Bonus.giver.id description: ID of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.short_name description: Short name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.display_name description: Display name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.username description: Username of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.email description: Email address of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.path description: URL path of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.full_pic_url description: URL path to the full picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.profile_pic_url description: URL path to the profile picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.first_name description: First name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_name description: Last name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_active_at description: Last time the bonus giver was active when available. type: Unknown - contextPath: Bonusly.Bonus.giver.external_unique_id description: Unique ID for the bonus giver (external). type: String - contextPath: Bonusly.Bonus.giver.budget_boost description: Whether a boost was given for the bonus. type: Number - contextPath: Bonusly.Bonus.giver.user_mode description: User mode of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.country description: Country where the bonus giver resides. type: String - contextPath: Bonusly.Bonus.giver.time_zone description: Timezone of the bonus giver, e.g., America/Los_Angeles. type: String - contextPath: Bonusly.Bonus.giver.*custom_property_name* description: Custom properties given in the bonus. type: String - contextPath: Bonusly.Bonus.giver.can_give description: Whether the giver can give bonuses. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance description: Available earning balance. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance_with_currency description: Earning balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.lifetime_earnings description: Lifetime earnings of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.lifetime_earnings_with_currency description: Lifetime earnings of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.can_receive description: Whether the bonus giver can receive bonuses. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance description: Points balance of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance_with_currency description: Points balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.status description: Status of the bonus giver, e.g., archived. type: String - contextPath: Bonusly.Bonus.receiver description: Bonus receiver. type: Unknown - contextPath: Bonusly.Bonus.child_count description: Count of the child add-on bonuses. type: Number - contextPath: Bonusly.Bonus.via description: Bonus source, e.g., Web. type: String - contextPath: Bonusly.Bonus.family_amount description: Family bonus balance. type: Number - arguments: - description: ID of the bonus to get information for. name: id required: true description: Gets a bonus by bonus ID. name: bonusly-get-bonus outputs: - contextPath: Bonusly.Bonus.id description: Bonus ID. type: String - contextPath: Bonusly.Bonus.created_at description: Date the bonus was created (given), e.g., 2015-10-28T21:26:50Z. type: Date - contextPath: Bonusly.Bonus.reason description: 'The bonus message, e.g., "For signing up for the world''s favorite employee recognition solution! #problem-solving".' type: String - contextPath: Bonusly.Bonus.reason_html description: HTML representation of the bonus. type: String - contextPath: Bonusly.Bonus.amount description: Number of points given in the bonus. type: Number - contextPath: Bonusly.Bonus.amount_with_currency description: Number and currency of points given in the bonus. type: String - contextPath: Bonusly.Bonus.value description: 'Hash tag included in the bonus, e.g., #problem-solving.' type: String - contextPath: Bonusly.Bonus.giver.id description: ID of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.short_name description: Short name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.display_name description: Display name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.username description: Username of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.email description: Email address of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.path description: URL path of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.full_pic_url description: URL path to the full picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.profile_pic_url description: URL path to the profile picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.first_name description: First name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_name description: Last name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_active_at description: Last time the bonus giver was active when available. type: Unknown - contextPath: Bonusly.Bonus.giver.external_unique_id description: Unique ID of the bonus giver (external). type: String - contextPath: Bonusly.Bonus.giver.budget_boost description: Whether a boost was given for the bonus. type: Number - contextPath: Bonusly.Bonus.giver.user_mode description: User mode of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.country description: Country where the bonus giver resides. type: String - contextPath: Bonusly.Bonus.giver.time_zone description: Timezone of the bonus giver, e.g., America/Los_Angeles. type: String - contextPath: Bonusly.Bonus.giver.*custom_property_name* description: Custom properties given in the bonus. type: String - contextPath: Bonusly.Bonus.giver.can_give description: Whether the giver can give bonuses. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance description: Available earning balance. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance_with_currency description: Earning balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.lifetime_earnings description: Lifetime earnings of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.lifetime_earnings_with_currency description: Lifetime earnings of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.can_receive description: Whether the bonus giver can receive bonuses. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance description: Points balance of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance_with_currency description: Points balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.status description: Status of the bonus giver, e.g., archived. type: String - contextPath: Bonusly.Bonus.receiver description: Bonus receiver. type: Unknown - contextPath: Bonusly.Bonus.child_count description: Count of the child add-on bonuses. type: Number - contextPath: Bonusly.Bonus.via description: Bonus source, e.g., Web. type: String - contextPath: Bonusly.Bonus.family_amount description: Family bonus balance. type: Number - arguments: - description: 'ID of the bonus to update. ' name: id required: true - description: 'Example +10 @francesco @bumblebee for #integrity #collaboration #execution.' name: reason required: true description: Updates a bonus. name: bonusly-update-bonus outputs: - contextPath: Bonusly.Bonus.id description: Bonus ID. type: String - contextPath: Bonusly.Bonus.created_at description: Date the bonus was created (given), e.g., 2015-10-28T21:26:50Z. type: Date - contextPath: Bonusly.Bonus.reason description: 'The bonus message, e.g., "For signing up for the world''s favorite employee recognition solution! #problem-solving".' type: String - contextPath: Bonusly.Bonus.reason_html description: HTML representation of the bonus. type: String - contextPath: Bonusly.Bonus.amount description: Number of points given in the bonus. type: Number - contextPath: Bonusly.Bonus.amount_with_currency description: Number and currency of points given in the bonus. type: String - contextPath: Bonusly.Bonus.value description: 'Hash tag included in the bonus, e.g., #problem-solving.' type: String - contextPath: Bonusly.Bonus.giver.id description: ID of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.short_name description: Short name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.display_name description: Display name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.username description: Username of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.email description: Email address of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.path description: URL path of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.full_pic_url description: URL path to the full picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.profile_pic_url description: URL path to the profile picture of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.first_name description: First name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_name description: Last name of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.last_active_at description: Last time the bonus giver was active when available. type: Unknown - contextPath: Bonusly.Bonus.giver.external_unique_id description: Unique ID for the bonus giver (external). type: String - contextPath: Bonusly.Bonus.giver.budget_boost description: Whether a boost was given for the bonus. type: Number - contextPath: Bonusly.Bonus.giver.user_mode description: User mode of the bonus giver. type: String - contextPath: Bonusly.Bonus.giver.country description: Country where the bonus giver resides. type: String - contextPath: Bonusly.Bonus.giver.time_zone description: Timezone of the bonus giver, e.g., America/Los_Angeles. type: String - contextPath: Bonusly.Bonus.giver.*custom_property_name* description: Custom properties given in the bonus. type: String - contextPath: Bonusly.Bonus.giver.can_give description: Whether the giver can give bonuses. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance description: Available earning balance. type: Number - contextPath: Bonusly.Bonus.giver.earning_balance_with_currency description: Earning balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.lifetime_earnings description: Lifetime earnings of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.lifetime_earnings_with_currency description: Lifetime earnings of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.can_receive description: Whether the bonus giver can receive bonuses. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance description: Points balance of the bonus giver. type: Number - contextPath: Bonusly.Bonus.giver.giving_balance_with_currency description: Points balance of the bonus giver (with currency). type: String - contextPath: Bonusly.Bonus.giver.status description: Status of the bonus giver, e.g., archived. type: String - contextPath: Bonusly.Bonus.receiver description: Bonus receiver. type: Unknown - contextPath: Bonusly.Bonus.child_count description: Count of the child add-on bonuses. type: Number - contextPath: Bonusly.Bonus.via description: Bonus source, e.g., Web. type: String - contextPath: Bonusly.Bonus.family_amount description: Family bonus balance. type: Number - arguments: - description: ID of the bonus to delete. name: id required: true description: Deletes a bonus by bonus ID. name: bonusly-delete-bonus outputs: - contextPath: Bonusly.Bonus.message description: Message. type: Unknown dockerimage: demisto/python3:3.12.13.10116658 isfetch: true runonce: false script: '-' subtype: python3 type: python tests: - No tests fromversion: 5.0.0