Skip to main content

Webhook

Webhook é uma forma de envio e recebimento de informações entre duas ou mais aplicações. Neste caso, servirá para ativar um robô via API.

Como criar seu Token para webhook​

CUIDADO

Seu Token NÃO deve ser enviado para ninguém. Apenas os desenvolvedores do robô devem ter acesso ao Token.

  1. Dentro do seu robô, clique no ícone de engrenagem para abrir as Configurações do robô.

    openSettings

  2. Com a tela de Configurações do Robô aberta, vá até a sessão Token para Webhook e clique no ícone de geração de token. tokenParaWebhook

  3. Clique em Sim para confirmar a geração de um novo Token para Webhook. gerarTokenAlert

Parabéns, seu novo Token para Webhook foi criado com sucesso!

  1. Basta copiar seu Token e usá-lo para realizar a comunicação entre a API dos eu sistema e a API do Roberty. copyToken

Como usar o webhook do Roberty​

Nessa seção será apresentado como utilizar o webhook do Roberty

Como executar seu robô através do webhook​

Com POST​

  • Basta realizar a requisição à API do Roberty utilizando o método http POST e enviar no corpo da requisição, um objeto contendo os argumentos e o Token gerado anteriormente.
A requisição deve ser feita para
https://api.roberty.app/main/public/webhook/request
Exemplo do corpo da requisição
{
    "nome": "Roberty"
    ...outros argumentos
}
Exemplo do cabeçalho da requisição
{
   "x-roberty-token": "TokenGeradoAnteriormente"
}

Com GET​

  • A diferença do POST é que os parâmetros são enviados na URL da requisição. Como mostrado abaixo:
A requisição deve ser feita para
https://api.roberty.app/main/public/webhook/request?nome=Roberty&...outros argumentos
Exemplo do cabeçalho da requisição
{
   "x-roberty-token": "TokenGeradoAnteriormente"
}
info

O cabeçalho em ambas deve possuir obrigatoriamente o x-roberty-token.

  • Ao realizar a requisição, a API do Roberty traz uma resposta com um parâmetro chamado webhookCallId, que pode ser usado para consultar o status da execução do robô e respostas personalizadas que podem ser usadas ao utilizar a action Responder Webhook.
Resposta obtida
{
    "webhookCallId": "valorDoWebHookCallId"
}

Como obter a resposta de execução do Robô​

  • Basta realizar a requisição à API do Roberty utilizando o método http GET e passar o webhookCallId como parâmetro da rota.
A requisição deve ser feita para
https://api.roberty.app/prod/1/customer/robot/webhookResponse/{webhookCallId}
  • As respostas que podem ser obtidas por padrão são:
  1. WAITING: Resposta obtida enquanto o robô está executando e não há a action de Responder Webhook.
  2. Resposta Personalizada:
Resposta personalizada usando a action Responder Webhook
{
  "response": {
      "nome": "Roberty"
  },
  "status": "DONE"
}