# Heartbeat

The Heartbeat component is an all-in-one platform for community businesses that helps monitor and alert.

#### **How to Connect Heartbeat Component to ZBrain Flow?**

To integrate Heartbeat with ZBrain Flow, follow these steps to select and utilize the desired capabilities:

1. **Search for the Heartbeat Component**: Search the Heartbeat component within the ZBrain interface.
2. **Select the Required Capability**: Select the desired capability from these:

* **Create User:** Create a new user in a Heartbeat community.
* **Custom API Call:** Send a custom API call to a specific endpoint.

#### **Additional Settings for Creating User**

**Required Fields**

1. **API Key**\* - Select the API connection to authenticate the request.
2. **Name**\* - Enter the full name of the user.
3. **Email**\* - Provide a unique email address for the user.
4. **Roles**\* - Select the role(s) that the user should have.

**Optional Fields**

1. **Groups** - Enter the group IDs the user should belong to.
2. **Profile Picture** - Upload an image (JPG, GIF, or PNG format) as a Data URI.
3. **Bio** - Provide a brief biography for the user.
4. **Status** - Enter the user's status message.
5. **LinkedIn** - Add a link to the user's LinkedIn profile.
6. **Twitter** - Add a link to the user's Twitter profile.
7. **Instagram** - Add a link to the user's Instagram profile.
8. **Create Introduction Thread** - If enabled and a **bio** is provided, an introduction thread will be created for the user.

#### **Additional Settings for Custom API Call**

This action allows users to make custom API requests to the Heartbeat platform, enabling advanced interactions beyond predefined actions.

**Required Fields**

1. **API Key\* -** Select the API connection to authenticate the request.
2. **URL\* -** Enter the API endpoint URL (e.g., <https://api.heartbeat.chat/v0>).
3. **Method\* -** Select the HTTP method for the request (GET, POST, PUT, DELETE).
4. **Headers\* -** Add authorization and additional headers as key-value pairs.
5. **Query Parameters\* -** Add query parameters as key-value pairs.

**Optional Fields**

1. **Body -** Enter the request body in JSON format for POST and PUT requests.
2. **Timeout (in seconds) -** Set a timeout duration for the request.

**Optional Settings**

1. **No Error on Failure -** Prevents errors from stopping the workflow.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.zbrain.ai/zbrain-documentation/zbrain-builder/flows/flow-components/heartbeat.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.