Passar para o conteúdo principal

Disponibilização de rotas para integração com automações externas via Webhook

Disponibilizamos um conjunto de rotas específicas para quem deseja integrar automações externas à experiência de suas comunidades.

Atualizado há mais de um mês

Essa funcionalidade é ideal para empresas que utilizam soluções de automação, curadoria de conteúdo ou inteligência artificial (IA), e buscam responder ou interagir com seus membros de forma independente, flexível e automatizada.

O que essa integração permite?

Através das rotas expostas pela plataforma, parceiros externos podem:

  • Receber webhooks em tempo real com interações da comunidade;

  • Analisar ou processar o conteúdo recebido;

  • Retornar comentários ou respostas automaticamente dentro da plataforma da Nichoos.

Estrutura do fluxo

A integração foi pensada com base em três tipos de interações comuns nas comunidades:

  1. Comentários feitos em posts;

  2. Respostas a comentários em posts;

  3. Comentários ou respostas dentro de aulas (conteúdos educacionais).

O fluxo ideal é:

  1. Um evento acontece na comunidade (ex: comentário de um usuário);

  2. A Nichoos envia um webhook para a aplicação externa;

  3. A aplicação interpreta o conteúdo e responde por uma das rotas descritas abaixo.


Informações técnicas

Autenticação

Todas as requisições às rotas devem conter um token de autenticação válido no cabeçalho, usando o padrão Bearer Token:

makefile

Authorization: Bearer SEU_TOKEN_DE_AUTENTICAÇÃO

O token de autenticação é gerado exclusivamente para cada cliente Enterprise e deve ser mantido em segurança.

Base URL

Todas as rotas disponíveis seguem a seguinte base:

arduinoCopiarEditarhttps://nichoos.top

Rotas disponíveis

1. Criar comentário em um post

Endpoint/Rota:

bashCopiarEditarPOST /comment

Descrição:

Permite enviar um novo comentário diretamente em uma publicação feita na comunidade.

Payload:

json

{
"id": "ID da postagem",
"comment": "Comentário a ser feito",
"email": "emaildocomentarista@exemplo.com",
"companyparam": "nomedacomunidade"
}

2. Responder a um comentário em post

Endpoint:

bash

POST /reply

Descrição:

Permite responder a um comentário feito em uma postagem.

Payload:

json

{
"id": "ID da postagem",
"commentid": "ID do comentário",
"reply": "Texto da resposta",
"email": "emaildoautor@exemplo.com",
"companyparam": "nomedacomunidade"
}

3. Responder a comentários em aulas

Endpoint/Rota:

bash

POST /reply-content

Descrição:

Permite responder a um comentário feito dentro de uma aula (vídeo, material de leitura, etc.).

Payload:

json

{
"comentId": "ID do comentário ou pergunta",
"email": "emaildoautor@exemplo.com",
"reply": "Texto da resposta",
"companyparam": "nomedacomunidade"
}

O campo comentId é recebido previamente via webhook disparado pela plataforma ao detectar uma nova interação no conteúdo da aula.


Notificações (em desenvolvimento)

Atualmente, apenas os administradores da comunidade recebem notificações quando um membro comenta em uma aula. Estamos trabalhando para estender esse recurso, de forma que:

  • O usuário que fez a pergunta também receba uma notificação quando houver resposta.

Essa melhoria garantirá mais engajamento e fechamento de ciclos de interação dentro do conteúdo educacional.


Disponibilidade

A disponibilização dessas rotas é um recurso exclusivo para clientes com plano Enterprise.


Se sua organização tem interesse em habilitar esse tipo de integração, entre em contato com o time da Nichoos pelo e-mail nichoos@nichoos.com ou fale diretamente com seu/sua gerente de contas.

Respondeu à sua pergunta?