Guia de integração

Configure os webhooks da Rank Prompt

Pare de consultar. A Rank Prompt chama o seu endpoint assim que um relatório ou uma execução agendada termina, ou falha, com um payload assinado em que o seu servidor pode confiar.

Comece grátis Conheça o recurso
Webhooks

A Rank Prompt lê

  • O código de resposta do seu endpoint

A Rank Prompt envia

  • Tipo e id do evento
  • Payload do relatório ou da execução
  • Assinatura HMAC
  • Id da entrega
Rank Prompt

O que faz

  • Envia report.completed, report.failed, schedule.run.completed e schedule.run.failed para o seu endpoint, por marca.
  • Assina cada entrega com HMAC para você provar que ela vem da Rank Prompt.
  • Tenta de novo uma entrega que falhou após 30 segundos, 2 minutos, 10 minutos, 1 hora, 6 horas e 24 horas.
  • Troca o segredo de assinatura sem interrupção, e desativa um endpoint depois de 20 falhas seguidas.
  • Também posta no Slack ou no Discord: escolha o tipo de destino e cada evento chega como uma mensagem escrita para o canal.
  • Inscreve um endpoint da marca também nos eventos de artigos: article.published, article.updated e article.unpublished.
  • Envia uma entrega de teste quando você quiser, assinada como uma real, com a resposta e o tempo que levou à vista.

Antes de começar

Plano A partir do Starter

  • Um endpoint HTTPS público no seu servidor que responda rápido com um código 2xx.
  • Um lugar para guardar o segredo de assinatura, como o seu gerenciador de segredos.
  • Até 5 endpoints ativos por marca.
Configuração

Webhooks: configuração em 4 passos

  1. Passo 1

    Abra Desenvolvedores, Webhooks

    Na Rank Prompt, abra Desenvolvedores, escolha a aba Webhooks e a marca.

    A aba Webhooks da página API para desenvolvedores, com o seletor de marca e o botão Novo webhook.

  2. Passo 2

    Adicione o seu endpoint

    Clique em Novo webhook, digite a URL https e escolha os eventos que ele deve receber.

  3. Passo 3

    Guarde o segredo de assinatura

    Copie o segredo para o seu servidor. Cada entrega traz X-RP-Signature com um timestamp e uma assinatura v1; recalcule sobre o corpo bruto e compare.

  4. Passo 4

    Processe as entregas

    Responda rápido com um 2xx e depois faça o trabalho. Use X-RP-Event-Id para ignorar uma nova tentativa que você já processou.

Solução de problemas

Webhooks: erros e soluções

Estas são as mensagens que o app mostra, palavra por palavra, e o que resolve cada uma.

  • O máximo de 5 webhooks ativos por marca foi atingido.

    Desative ou apague um endpoint que você não usa mais, ou mande vários tipos de evento para o mesmo endpoint.

  • Desativamos o webhook de Mercari (JSON assinado, b3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d) após 20 entregas falhas consecutivas. Corrija o endpoint e reative-o para retomar os eventos.

    Faça o endpoint voltar a responder com 2xx e reative-o na aba Webhooks. As entregas descartadas podem ser reenviadas de lá.

Todas as integrações

Perguntas frequentes

Perguntas frequentes: Webhooks

Ainda tem dúvidas? Fale com nossa equipe

Em quais eventos posso me inscrever?

report.completed, report.failed, schedule.run.completed e schedule.run.failed, além de article.published, article.updated e article.unpublished, por marca. No Agency Plus o dono da conta também pode criar endpoints da conta para lead.created, lead.report_ready, lead.report_failed e lead.claimed, em Developers, Webhooks, em Conta (/developers?tab=webhooks&scope=account).

O que acontece se o meu endpoint estiver fora do ar?

A entrega é tentada de novo seis vezes ao longo de cerca de um dia: após 30 segundos, 2 minutos, 10 minutos, 1 hora, 6 horas e 24 horas. Depois de 20 falhas seguidas o endpoint é desativado até você reativá-lo.

Como verifico uma entrega?

Recalcule o HMAC do timestamp e do corpo bruto com o seu segredo de assinatura e compare com a assinatura em X-RP-Signature. A documentação para desenvolvedores tem o código.

De qual plano eu preciso?

Os webhooks começam no Starter, por $49 ao mês, ou vêm com um plano de API avulso.

Posso enviar eventos para o Slack ou o Discord?

Sim. Escolha Slack ou Discord como tipo de destino e cole a URL do webhook de entrada do canal: cada evento chega como uma mensagem para esse canal, no idioma do dono.

Como testo um endpoint?

Clique em Enviar teste no endpoint. O teste é assinado como uma entrega real, traz test: true, nunca conta para a desativação automática e mostra a resposta e o tempo do seu endpoint. Um Replay no registro de entregas envia uma entrega nova com id de entrega novo e o mesmo id de evento e corpo da primeira.

É assim que publico artigos no Zapier ou no Make?

Não, para isso existe o destino webhook: ele envia o artigo inteiro, assinado, ao publicar, e registra onde ele foi ao ar. Os webhooks daqui avisam as suas ferramentas de que algo aconteceu.

Funcionando em poucos minutos

Crie uma conta grátis, siga os passos acima e veja o que a conexão soma à sua visibilidade em IA.

Comece grátis Ver preços