What are Webhooks

A webhook enables PraisePal to push real-time notifications to your app via a JSON payload. PraisePal uses HTTPS to send these notifications and you can then use these notifications to execute actions in your backend systems.

Who can use this feature

👑 Available to Workspaces on the Starter Plan and above.

⚙️ Global Admin Permissions are required

Use Cases:

Integrate with 3rd party services to get instant notifications, such as Lark, Facebook Workplace, or any others that support webhooks.
Export a list of Recognitions and Comments to services such as Google Sheets or Airtable, for analysis or accountability.

Implementation:

The Webhook feature can be enabled within the Admin Settings menu, under the Integrations tab.

You can either get your technical team to set up a webhook endpoint on your application's server, or implement it yourself with various no-code tools. Some no-code tools which can process webhooks include:

Once you have a webhook endpoint, simply paste the URL into the input field under Webhooks, and hit Save. Each time a recognition or comment is posted, a payload will be sent to the webhook endpoint that you pasted.

Note:

PraisePal webhooks do not currently have a retry mechanism in place and we will only attempt to send each recognition/comment once.
We currently only support a single webhook endpoint per PraisePal Workspace.

Webhook Endpoint Object:

Our webhook will send recognition data in the following format, with all data types sent as a string:

{ 
"id":"1234567891231x123456789123456789", 
"giver_name":"Jonathan Vuk", 
"recipients":"Zelia Leong, Felix Tan", 
"type":"Recognition", 
"points":"123", 
"total_points":"246", 
"message":"What a great presentation! Absolutely smashed it and way to go for that extra last slide :)", 
"privacy":"Public", 
"company_value":"#deliver-results" 
"parent_recognition_id":" ",
"link":"https://app.praisepal.com/?recognition_view=single&recognition=1234x1234" 
"timestamp":"Nov 4, 2021 4:20 pm" 
}

id: The unique ID of the recognition or comment.
giver_name: The name of the User who left the recognition or comment.
recipients: The names, separated by a comma, of the Users who are recipients of the recognition or comment.
type: The type of recognition, either "Recognition" or "Comment".
points: The points given to each individual recipient in the recognition or comment. Listed as 0 if there are no points given in the comment.
total_points: The total number of points given to all the recipients in the recognition or comment. Listed as 0 if there are no points given in the comment.
message: The message content of the recognition or comment.
privacy: The privacy of the recognition or comment. This can be either "Public" or "Private. However, all comments are by default "Public", though if their parent recognition is "Private", the corresponding comment inherits that privacy too.
company_value: The name of the company value that is included in the recognition, if any. Comments do not have any company value, and this will be sent as an empty string.
parent_recognition_id: The unique ID of the parent recognition if the current data is for that of a comment. Recognitions do not have any parent recognition ID, and this will be sent as an empty string.
link: Adding this link to a CTA, like a button, will direct the User to that specific recognition. Note: It's important to note that this includes private recognitions. Any User that has a link to a private recognition will be able to view the private recognition.

This feature is currently still in Beta, do reach out with any feedback for improvements on how we can make this work better for you.