Central de ajudaIntegrações

Para: Administradores

Pesquise eventos e payloads de webhook.

O que cada um dos dez eventos de feed envia, como a mensagem é criptografada e como descriptografá-la com sua chave secreta.

Neste artigo4 seções

Esta página lista os eventos que um webhookWebhook Um endereço que você fornece ao hub para que ele possa enviar uma mensagem aos seus sistemas sempre que uma publicação ou comentário no feed for alterado. envia, como cada mensagem chega até o destino desejado, e o que cada mensagem contém após ser decodificada.

Eventos

EventoNa telaEnviado quandocontent contém
add_postO post foi criado.Alguém publica informações sobre um caso no Feed do caso em questão.new: o texto da publicação
modify_postO post foi modificado.O texto da publicação foi alterado.new: o novo texto
delete_postO post foi excluído.A publicação foi apagada.old: seu texto
add_post_commentO comentário é criado.Alguém comenta sobre uma publicação.new: o texto do comentário
modify_post_commentO comentário foi modificado.O texto do comentário foi alterado.new: o novo texto
delete_post_commentO comentário foi apagado.O comentário foi apagado.old: seu texto
add_post_mediaOs meios de comunicação sociais são criados.Um arquivo é adicionado a uma publicação.new: um link para o arquivo.
delete_post_mediaO conteúdo do post foi excluído.Um arquivo é removido de uma publicação.old: um link para o arquivo removido.
add_post_comment_mediaO meio de publicação de comentários é criado.Um arquivo é adicionado a um comentário.new: um link para o arquivo.
delete_post_comment_mediaO meio de comentário foi excluído.Um arquivo é removido de um comentário.old: um link para o arquivo removido.
  • Em cada caso no seu hub, eles são enviados, independentemente de quem fez a alteração: funcionários, clientes, o Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual., uma chave de importação ou uma chave de API. Os eventos relacionados a posts ou comentários ainda são enviados mesmo depois que o autor deles saiu do caso.
  • A exclusão de um caso não envia nenhum resultado, nem mesmo o valor delete_post para as postagens que são removidas com essa exclusão. Uma vez que o caso é excluído, a API responde com um erro 404 para esse caso.
  • Apenas as publicações e os comentários sobre as publicações podem gerar eventos. Notas, tarefas, formulários, assinaturas eletrônicas, além dos eventos e seus comentários, não geram nenhum tipo de evento. Da mesma forma, uma mudança na configuração de quem pode visualizar uma publicação também não gera nenhum evento.
  • Uma publicação que contém arquivos envia add_post, e, para cada arquivo, é enviado um add_post_media.
  • O link para o arquivo funciona por 48 horas. O arquivo removido é apagado logo em seguida. Portanto, o link presente em um evento de exclusão pode não funcionar.
  • A menção no texto é representada por <@, que indica o ID de usuário da pessoa; e >, como <@cu-4f1c2a9e8b7d60>.

Entrega

  • Cada mensagem é um pedido enviado para o endereço do webhook. O corpo da mensagem é um arquivo JSON, que contém um único campo: payload: a mensagem encriptada.
  • Qualquer status abaixo de 400, em até 10 segundos, é considerado como entregue.
  • Uma entrega que falha não é enviada novamente. Dois erros consecutivos interrompem o envio via webhook. Veja Corrija o webhook que parou de enviar os dados.
  • Uma mensagem pode chegar duas vezes, ou de maneira desordenada. Use o evento, o ID do item e when para indicar isso.
{"payload": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.…"}

Decifrando

payload é um JWE em formato compacto, encriptado utilizando os algoritmos RSA-OAEP e A128CBC-HS256. A chave secreta do webhook é a chave privada correspondente, um arquivo PEM que começa com -----BEGIN PRIVATE KEY-----. Use o arquivo baixado, ou a chave secreta copiada inteiramente, incluindo as linhas de divisão entre as linhas de texto. Qualquer biblioteca JOSE pode descriptografá-lo.

Python, com o jwcrypto:

import json
from jwcrypto import jwk, jwt

with open("webhook-private-key.pem", "rb") as f:
    key = jwk.JWK.from_pem(f.read())

def read_message(body):
    token = jwt.JWT(jwt=body["payload"], key=key, expected_type="JWE")
    return json.loads(token.claims)

Node.js, com o jose:

import { readFileSync } from 'node:fs';
import { compactDecrypt, importPKCS8 } from 'jose';

const key = await importPKCS8(readFileSync('webhook-private-key.pem', 'utf8'), 'RSA-OAEP');

export async function readMessage(body) {
  const { plaintext } = await compactDecrypt(body.payload, key);
  return JSON.parse(new TextDecoder().decode(plaintext));
}

Não existe uma assinatura separada. O seu hub nunca exibe a chave com a qual ele criptografa as mensagens. Portanto, uma mensagem que pode ser decodificada usando o seu segredo vem do seu hub. Porém, uma mensagem que é alterada no caminho de envio não consegue ser decodificada. Se vários hubs enviarem mensagens para o mesmo endereço, verifique também who.host.host_id.

A mensagem

O texto decodificado é: add_post

{
  "who": {
    "user_id": "cu-4f1c2a9e8b7d60",
    "cc_owner": false,
    "post": {"post_id": "post::20261001140322_9f8e7d6c5b4a32"},
    "case": {"case_id": "cc-1a2b3c4d5e6f70", "case_ref_id": "rear-end-2026"},
    "role": {"role_id": "role::staff"},
    "host": {"host_id": "ca-7e6d5c4b3a2f10"}
  },
  "what": {
    "trigger": {"name": "add_post"},
    "content": {
      "new": "Hi Jane, your records request went out today.",
      "type": "app_add_post",
      "kwargs": {"case_id": "cc-1a2b3c4d5e6f70", "case_ref_id": "rear-end-2026"}
    }
  },
  "where": {"location": {"name": "app"}, "module": {"name": "post"}},
  "when": {"datetime": {"timezone": "utc", "datetime": "2026-10-01T14:03:22.123456+0000"}},
  "targets": {"user_ids": ["cu-4f1c2a9e8b7d60"], "cc_user_ids": [], "group_targets": false}
}
CampoO que contém
what.trigger.nameO evento, conforme indicado na tabela acima
what.content.new ou what.content.oldO texto, ou um link para o arquivo
who.user_idQuem escreveu o post ou o comentário? Mesmo quando alguém alterou ou apagou o conteúdo dele.
who.post.post_idO post, sobre eventos passados
who.comment.comment_idO comentário, sobre os eventos relacionados aos comentários.
who.comment.post_idO post no qual o comentário está publicado
who.case.case_idO caso, de acordo com o ID utilizado pela API.
who.case.case_ref_idO ID da etiquetaID da etiqueta Uma etiqueta permanente que você atribui a um caso, como rear-end-2026, também exibida como ID de referência e usada em importações. do caso
who.role.role_idO papel do autor no caso, como role::clients. Faltando se eles tiverem deixado o caso.
who.host.host_idSeu parceiro/companheiro
when.datetime.datetimeQuando isso aconteceu, no fuso horário UTC.

Os outros campos são destinados ao uso próprio do hub; ignore-os.

Artigos relacionados

Configure um webhook para a atividade do feed.Envie uma mensagem ao seu sistema sempre que uma publicação, comentário ou anexo for adicionado, alterado ou excluído do feed.Integrações · 10 minCorrigir webhook que parou de enviarPor que um webhook para de funcionar após duas entregas falhas ou quando está inativo, e como salvá-lo novamente o reativa.Integrações