NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Heartbeat

heartbeat

Plug-and-play online communities. Heartbeat provides tools for creating and managing online communities with features for users, channels, events, messages, and more.

Team CollaborationWeb del proveedor
Acciones
7
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (7)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Get EventsHEARTBEAT_GET_EVENTSAcción

Tool to retrieve event information from the community. Use when you need to list events with optional pagination support.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List channelsHEARTBEAT_LIST_CHANNELSAcción

Tool to retrieve a paginated list of channels in the community. Use when you need to list, browse, or search for channels in the Heartbeat community. Supports filtering by archived status, channel type, and pagination.

Parámetros de entrada

  • limitinteger

    Number of results per page. Must be between 1 and 100. If not specified, uses the API's default pagination size.

  • archivedstringenum

    Filter by archived status. Use 'all' for all channels, 'active' for active channels only, 'archived' for archived channels only. If not specified, defaults to active channels.

    allactivearchived
  • channelTypestringenum

    Filter by channel type. Use 'thread' for thread channels, 'chat' for chat channels, 'voice' for voice channels. If not specified, returns all types.

    threadchatvoice
  • startingAfterstring

    Cursor token for pagination to fetch the next page of results. Use the cursor from the previous response to get the next page. Omit for the first page.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List GroupsHEARTBEAT_LIST_GROUPSAcción

Tool to retrieve a paginated list of access groups in the community. Use when you need to browse groups with optional filters for parent groups or user membership. Supports cursor-based pagination.

Parámetros de entrada

  • limitinteger

    Number of results to return (1-100). Used for pagination.

  • userIdstring

    Filter groups that a user is a member of. Returns only groups where the specified user is a member.

  • parentGroupIdstring

    Filter by parent group. Returns only groups that are children of the specified parent group ID.

  • startingAfterstring

    Cursor for pagination - returns results after this ID. Used to fetch the next page of results.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List UsersHEARTBEAT_LIST_USERSAcción

Tool to retrieve a paginated list of users in the Heartbeat community. Use when you need to get user information with optional filtering by creation date, group membership, or role.

Parámetros de entrada

  • rolestring

    Filter by user role ID

  • limitinteger

    Number of results to return per page (1-100)

  • groupIdstring

    Filter by group membership - returns only users in the specified group

  • createdAfterstring

    Filter users created after this date (ISO 8601 format)

  • createdBeforestring

    Filter users created before this date (ISO 8601 format)

  • startingAfterstring

    Cursor for pagination - return results after this user ID

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Reactivate UserHEARTBEAT_REACTIVATE_USERAcción

Tool to reactivate a previously deleted user by email to allow them to access the community again. Use when you need to restore access for a user who was previously removed.

Parámetros de entrada

  • emailstringObligatorio

    Email address of the user to reactivate. The user must have been previously deleted from the community.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve GroupHEARTBEAT_RETRIEVE_GROUPAcción

Tool to retrieve a single group by its ID. Use when you need to get detailed information about a specific group in the Heartbeat community.

Parámetros de entrada

  • group_idstringObligatorio

    The unique identifier for the group to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve UserHEARTBEAT_RETRIEVE_USERAcción

Tool to retrieve a single user by their ID. Use when you need to get detailed information about a specific user in the Heartbeat community.

Parámetros de entrada

  • user_idstringObligatorio

    The unique identifier for the user to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not