API

This page contains the integration settings for your account and explains how to use the API.

Client key

The Client Key is a required parameter that must be included in every request to the Track and Identify API. It must be sent in the request header using the key name Client-Key. This key is used to authenticate the source of the request and associate the data with the correct client account. If the key is missing or invalid, the API call will be rejected.

You can find your API KEY from Settings > Intagration

Identify API

POST https://api.hoodleapp.com/api/contact/identify

The Identify API call is used to create a new contact or update an existing one in your system. If a contact with the given external_id already exists, their information will be updated; otherwise, a new contact will be created.

This API call requires one field:

• external_id: A unique identifier for the contact

Additionally, it accepts an optional data field, which must be a JSON object. All key-value pairs included in data will be stored and associated with the contact identified by external_id. This allows you to attach custom attributes (e.g., location, preferences, status) to each contact dynamically.

Track API

POST https://api.hoodleapp.com/api/event/track

The Track API call is used to log a custom event in your system. This allows you to record user or system actions that can later be used for automation, analytics, or behavioral triggers.

This API call requires the following field:

• name: The name of the event

It also accepts two optional fields:

• data: A JSON object containing additional event details. These key-value pairs can be used within automations or workflows triggered by this event.

• contact_external_id: If provided, the event will be associated with the contact matching this identifier

This flexible structure allows you to define and track any type of event and attach relevant metadata to enhance your automation capabilities.