Build integrations with Happily's employee engagement and people analytics to create automated and unique company workflows.
\nBring employee engagement to the forefront of your employee engagement by integrating your workflows with the Happily.ai. To get started, you will need to have an existing account with Happily (sign up for an account here) and request a developer access with our Customer Success team.
\nHappily.ai uses a delegated authentication and authorization flow so that your application never has to deal with storing or handling usernames or passwords. Instead, your application passes control to Happily.ai identifying itself via the API key.
\nGenerate an API key by logging into your My Happily account and visiting https://my.happily.ai/integrations.
\nYour API key should be a string comprised of random alphanumeric characters. Because API tokens grant access to the user's data, they should be kept secret.
\nNow that you have the API key for your account, you can use them to start making requests. One of the most popular resources in Happily.ai is the recognition object. So we will start by getting recognition that has been sent to a user.
\nYou can make a GET request to the /1/recognition/recipient/{member_email} resource and gather all of the recognition associated with a member:
curl --location --request GET 'https://api.happily.ai/dev/1/recognition/recipient/{member_email}?start_date=2022-01-01&end_date=2022-01-31&type=coin' \\ --header 'x-api-key: {API Key}' \\ --header 'x-api-key: commodo'
Be sure to replace the {API Key} parameters with the key values from above.
Once you've made the request above, you'll receive a response that contains a JSON object with information about all of the recognition associated with that member.
\nFrom here there are a lot of directions you can go. So now we'll tell you a little bit about the most popular resources and the ones that are core to working with Happily.ai.
\nIf you have any questions, please reach out to us:
Name: Happily.ai Support
Email: support@happily.ai
Get Recognitions for a Member
\n","urlObject":{"protocol":"https","path":["dev","1","recognition","recipient",":member_email"],"host":["api","happily","ai"],"query":[{"description":{"content":"first of current month (default)
\n","type":"text/plain"},"key":"start_date","value":"2022-01-01"},{"description":{"content":"today's date (default)
\n","type":"text/plain"},"key":"end_date","value":"2022-01-31"},{"description":{"content":"all (default), coin, gem, or medal_1, medal_2, medal_3, medal_4, medal_5, medal_6
\n","type":"text/plain"},"key":"type","value":"coin"}],"variable":[{"description":{"content":"(Required) member email
\n","type":"text/plain"},"type":"any","value":"jane@example.com","key":"member_email"}]}},"response":[{"id":"c924391e-38ce-4df8-9f91-e7bcf2b4c529","name":"200 response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Kindness","key":"medal_id"}]}},"response":[{"id":"14de047b-65ce-4ac7-8196-762a6e2ff6c7","name":"200 response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.happily.ai//dev/dev/1/recognition/medal/:medal_id","host":["https://api.happily.ai//dev/dev"],"path":["1","recognition","medal",":medal_id"],"variable":[{"key":"medal_id","value":"Kindness","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"statusCode\": 200,\r\n \"value\": \"Kindness\"\r\n}"}],"_postman_id":"e5b62c87-0f48-4382-b39a-477feea695d5"},{"name":"/1/recognition/:member_email","id":"62d6945d-b43a-4349-8dbe-e63b77d03f31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"jane@example.com","key":"member_email"}]}},"response":[{"id":"11748024-71ab-4423-b58a-7be97b6f9678","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":"