Integrações: webhooks de saída

Configurações → Integrações (endereço /app/settings/integrations) envia eventos deste espaço de trabalho para uma URL sua, por exemplo, uma ferramenta de automação (Zapier, Make, n8n) ou seu próprio servidor. Apenas Proprietário e Admin podem ver e alterar isso.

Passo a passo: adicionar um ponto final

1. Abrir Configurações → Integrações.
2. Em URL do endpoint, digite a URL do seu endpoint, por exemplo https://your-system.example.com/omnibrand-hook. Ela deve ser https e acessível pela internet pública; caso contrário, uma linha vermelha diz qual é o problema ("O endereço do endpoint deve começar com https://. Endereços http:// simples não são aceitos.", ou que ela não pode ser acessada pela internet).
3. Em Eventos, marque os eventos que este endpoint recebe. Cada caixa tem uma descrição simples e o nome do evento, por exemplo post.published ("Um post foi publicado"), post.failed, social_account.token_expired ou social_account.disconnected; Todos os eventos, incluindo os adicionados depois é *. workspace.created e invitation.accepted também estão lá. Marque pelo menos um, ou o formulário diz "Escolha pelo menos um evento."
4. Clique Adicionar endpoint.
5. Segredo de assinatura (copie agora - exibido apenas uma vez): aparece com o segredo, acima do formulário; a página rola até ele, então você também o vê no celular. Se o endpoint for recusado, a mensagem vermelha aparece no mesmo lugar e a página rola até ela. Copie o segredo no seu sistema receptor agora; A OmniBrand nunca mais o mostra (apenas os últimos quatro caracteres). Copiar segredo ao lado e copie para você.
6. Clique em Enviar teste no endpoint. Você vê ✓ entregue com o status HTTP que seu servidor retornou. Quando falha, você vê "Não entregue: seu servidor respondeu [status]." com o que corrigir, por exemplo, para 405 Método Não Permitido "Deve aceitar requisições POST neste endereço.", para 404 Não Encontrado "Nada responde neste endereço. Verifique a URL.", para um redirecionamento "Redirecionou para outro endereço, e webhooks nunca seguem redirecionamentos. Registre a URL final em vez disso."; ou, quando o servidor não pôde ser alcançado, "Não entregue: seu servidor não pôde ser alcançado ([motivo]). Verifique a URL e se o servidor está online." Um link de Como funcionam os webhooks abre este artigo.

Cada ponto final

• A URL e um distintivo ativo ou desativado.
• "eventos: ... · secreto ••••1234", com cada evento por sua descrição (por exemplo, "Uma postagem foi publicada"), além de "· N falhas consecutivas" quando tentativas de entrega falham e "· N aguardando uma nova tentativa" enquanto os eventos aguardam pela próxima tentativa.
• Uma linha vermelha "N entregas falhadas - abra o histórico de entregas para enviá-las novamente." quando os eventos desistiram (veja histórico de entregas e Reentrega abaixo).
• Ativado / Desativado pausa ou retoma as entregas. Enquanto a alteração é salva, o cartão diz "Funcionando..." e Enviar teste de enviar e Excluir aguardam; se o switch ou Excluir falharem, o motivo aparece em vermelho na parte inferior do cartão daquele endpoint, e a página rola até ele.
• Enviar teste envia um evento chamado 'webhook.test' uma vez (não é retentado e não é mantido no histórico).
• Histórico de entregas abre as entregas recentes do endpoint (o botão Ocultar histórico de entregas as fecha).
• Excluir pergunta "Excluir o webhook para (endereço)? Os eventos deixam de ser enviados para ele na hora e o segredo de assinatura dele é perdido para sempre. Para pausá-lo em vez disso, desligue a chave dele." A janela tem o título Excluir webhook?; clique em Excluir para remover o endpoint na hora ou em Cancelar para mantê-lo.

O que seu servidor recebe

Um POST com corpo JSON: id (o id do evento - use-o para ignorar duplicados), event (por exemplo, post.published), occurredAt e data (os detalhes do evento). Cabeçalhos:

• X-OmniBrand-Signature: sha256= seguido pelo HMAC-SHA256 do corpo bruto, marcado com seu segredo de assinatura.
• X-OmniBrand-Timestamp e X-OmniBrand-Signature-V2: o HMAC-SHA256 do carimbo de tempo, um ponto e o corpo - usam-no para rejeitar replays antigos.

Responda com qualquer status 2xx em até 5 segundos.

Tentativas: quanto tempo OmniBrand continua tentando

Todo evento é salvo antes de ser enviado, então nada se perde se seu servidor – ou o nosso – reiniciar. Quando seu servidor não responde com um status 2xx em até 5 segundos (um erro, um tempo expirado, um redirecionamento, qualquer resposta que não seja 2xx), o evento é tentado novamente após cerca de 1 minuto, 5 minutos, 15 minutos, 30 minutos, 1 hora, 2 horas, 4 horas, 8 horas e 12 horas - 10 tentativas ao longo de cerca de 28 horas. Cada espera varia em até 20%, então as tentativas não chegam todas ao mesmo tempo. Como uma tentativa de reação pode chegar após um evento posterior, use 'id' para ignorar duplicatas e 'occurredAt' para ordenar eventos.

Se todas as 10 tentativas falharem, a entrega é marcada Com falha e permanece no histórico por 30 dias, onde você pode enviar novamente.

Histórico de entregas e reentrega

1. No endpoint, clique em Histórico de entregas. Entregas recentes listam os últimos 30 dias, a mais recente primeiro.
2. Cada linha mostra um selo de status - Entregue, Tentando novamente ou Com falha - o nome do evento, quando aconteceu, "Tentativa N de 10", para Tentando novamente o tempo da "próxima tentativa", e para um que não passou por "Última resposta:" com o que seu servidor respondeu (por exemplo, "HTTP 503" ou "Sem resposta em 5 s").
3. Somente com falha para ver apenas as falhas; Mostrar anteriores . Sem nenhuma, diz "Nenhuma entrega falhada nos últimos 30 dias. Entregas ainda sendo retentadas não são contadas como falhadas." ( Tentando novamente ainda não foi falhada).
4. Para enviar uma novamente, clique em Reenviar na fileira. É enviada imediatamente: você vê "Entregue." ou "Ainda não entregue (resposta). É tentada novamente automaticamente." - um evento reentregue inicia uma nova sequência de 10 tentativas.
5. Para enviar todas novamente após consertar seu servidor, clique em Reenviar todas com falha (mostrado quando há entregas falhadas). Você vê "N entregas falhadas são enfileiradas e saem em um minuto."

O Redeliver precisa que o endpoint esteja ativado; enquanto estiver Desativado , os botões aguardam e o histórico diz "Este endpoint está desativado. Ligue o interruptor para reentregar." Eventos que chegam enquanto um endpoint está desativado não são enviados nem mantidos.

Se algo der errado

• Redirecionamentos nunca são seguidos; registre a URL final. Se o seu redirecionar, o teste diz "Não entregue: seu servidor respondeu 301 Movido Permanentemente. Ele redirecionou para outro endereço, e webhooks nunca seguem redirecionamentos. Registre a URL final em vez disso." (com o status que seu servidor enviou).
• Quando toda tentativa de acesso a um endpoint falha por um dia inteiro (pelo menos 20 tentativas seguidas), o endpoint é automaticamente desativado e os administradores são notificados. As entregas em espera são marcadas Com falha. Conserte o receptor, volte a opção para Ativado, depois abra o Histórico de entregas e clique em Reenviar todas com falha.

Acesso à API (para desenvolvedores)

No fim da página, o cartão Acesso à API (para desenvolvedores): "Conecte o OmniBrand aos seus próprios sistemas, ao Zapier ou ao Make para criar posts, adicionar contatos ou ler análises automaticamente." Nos planos Agency e Enterprise, ele guarda suas chaves para a API pública (veja Acesso à API). Nos outros planos, ele diz "O acesso à API está disponível no plano Agency." com um link Ver planos. Os webhooks desta página funcionam em todos os planos.

Bom saber

• Um endpoint recebe apenas os eventos desse espaço de trabalho, além de eventos de conta (faturamento e eventos da conta).
• O espaço de trabalho em que você está ao adicionar o endpoint é aquele ao qual ele pertence.