add contributing guide

integrations/hibob/CONTRIBUTING.md

@@ -1,7 +1,19 @@
 # Contributing to Ocean - hibob
 
+# HiBob Authentication
+
+For integration to work both locally and in production, you need to obtain [HiBob API Service User Credentials](https://apidocs.hibob.com/reference/authorization) and set up [Permissions](https://apidocs.hibob.com/reference/permissions). It is advised to grant the least permissions possible to the API Service User to mitigate any possible data leaks.
+
 ## Running locally
 
-#### NOTE: Add your own instructions of how to run hibob
+1. Fill in .env file values based .env.example using Port Credentials and HiBob API Service User obtained in `Hibob Authentication` section
+2. Run the integration: `make run`
+
+# API specification
+Currently, API endpoints in use are
+- Get Employees' Profiles to ingest `kind=profile`: https://apidocs.hibob.com/reference/get_profiles
+- Get Company Lists to ingest `kind=list`: https://apidocs.hibob.com/reference/get_company-named-lists
+
+## Possible next steps
 
-This could be any gotcha's such as rate limiting, how to setup credentials and so forth
+HiBob supports webhooks to update the employees' data in real time: https://apidocs.hibob.com/reference/getting-started-webhooks

integrations/hibob/examples/raw/lists.response.json

@@ -174,4 +174,4 @@
       }
     ]
   }
-}
+}

integrations/hibob/examples/raw/profiles.response.json

@@ -125,4 +125,4 @@
       "firstName": "Alice"
     }
   ]
-}
+}