Get Bonuses

Bonusly is a peer reward platform that allows its users to communicate, collaborate, and reward their colleagues on a daily basis. This action lets you retrieve the details of some or all bonus records from your Bonusly account. To do this, add this action to the canvas and configure it. Select the appropriate connection for Bonusly from the drop-down list. If you haven’t created a connection yet, select ‘Add New’ to create one.

Field data

Limit (Optional): Enter the number of records you wish to include in the result. 

Skip (Optional): Enter the number of records you wish to skip from the result.

Start Date (Optional): Specify the date to retrieve the bonus records created after it. 

End Date (Optional): Specify the date to retrieve the bonus records created before it. 

Start Time (Optional): Specify the time to retrieve the bonus records created after it. This field is mandatory if you have entered value for the 'Start Date' field.

End Time (Optional): Specify the time to retrieve the bonus records created before it. This field is mandatory if you have entered value for the 'End Date' field.

Giver Email (Optional): In the 'Giver Email’ field, you need to select/specify the name/email ID of the contact to retrieve the bonuses assigned by him. Clicking the ‘Refresh’ icon will fetch the list of all the email IDs of your Pivotal Tracker account—based on the connection selected—and display it in the drop-down list. 

In case there are too many , you can search the required one by its ‘name’ or ‘email ID’. Alternatively, you can manually enter the name or ID of the contact assigning the bonus or use the output of the previous action as an input for this field.

User Email (Optional): Enter the email ID of the user. 

Hashtag (Optional): Enter the hashtag, if you wish to retrieve bonuses by hashtag value. 

Received Email (Optional): Select/specify the email ID of the received to retrieve all the bonuses received by him. 

Include Children (Optional): Specify if you wish to include the child records along with its parent records in the result. Available options are 'True' and 'False'. By default, the value for this field is set to 'None'. 

Custom User Properties (Optional): Enter the custom property name-value pairs to retrieve the specific records. The structure for specifying name-value pairs is: 'property_name = property_value'.

get-bonuses

Once you have entered the details, click on 'Done' and 'Run' the workflow. This will retrieve some or all bonus records from your Bonusly account. 

 Refer to the API documentation for more information: https://bonusly.gelato.io/docs/versions/353215342023018198/resources/bonuses/endpoints/list-bonuses

Output:
  • output-arrow bonusly-128 Get Bonuses
    • left-triangle success boolean
    • left-triangle result array
      • left-triangle id string
      • left-triangle created_at string
      • left-triangle reason string
      • left-triangle reason_decoded string
      • left-triangle reason_html string
      • left-triangle amount integer
      • left-triangle amount_with_currency string
      • left-triangle value string
      • left-triangle hashtag string
      • left-triangle via string
      • left-triangle editable_until string
      • left-triangle giver object
      • left-triangle receiver object
      • left-triangle receivers array