Introduction

We are listing the available API endpoints for habitate.io. These can be used to build additional feature and create linked services around your community.

In case you need more help you can get in touch with the team, developer-support at habitate.io

Webhook Sample

Response parameters

{
  "event": "member.joined",
  "job_id": 164,
  "entities": {
    "user": [
      {
        "sid": "JO7Rv1B4bEBUawd3d2DXsE2DA",
        "msid": "206.JO7Rv1B4bEBUawd3d2DXsE2DA",
        "email": "sample@example.com",
        "role_id": 4,
        "user_id": 206,
        "username": "sample",
        "last_name": "free",
        "created_at": "2022-09-14T06:16:26Z",
        "first_name": "Sample",
        "user_avatar": "string",
        "user_status": 10
      }
    ]
  }
}

response parameters explanation

Please refer to the respective entity endpoint to understand the response details. The structure above is standardized for all the webhook events. Different entities are keys under the entities object in json and each key will have an array of objects even in case of single object. In the sample above the entities object has a key user which is an array of user objects. Since the event is member.joined the array will have only one object. Also, in the above case to understand the params refer to the user endpoint.