Cada solicitação de webhook informa o que aconteceu em seu espaço de trabalho ou em uma de suas centrais de ajuda. Este artigo lista todos os eventos que você pode selecionar para um endpoint, a aparência de cada solicitação e o que ela contém.
POSTideventversionoccurred_atsite_iddataEventos que você pode escolher
O painel agrupa os eventos da mesma forma que as tabelas abaixo. A primeira coluna é o nome que você vê no seletor de eventos. A segunda é o nome do evento que seu servidor recebe em event.
Contatos
| No painel de controle | Evento | Enviado quando |
|---|---|---|
| Mensagem de contato recebida | Um visitante enviou seu formulário de contato. | contact_message.created |
Contente
| No painel de controle | Evento | Enviado quando |
|---|---|---|
| Artigo criado | Um novo artigo, ou uma nova versão do artigo, é adicionado. | article.created |
| Artigo atualizado | O conteúdo de um artigo muda durante uma sincronização. | article.updated |
| Artigo publicado | A linguagem de um artigo é publicada | article.published |
| Artigo não publicado | A versão publicada de um artigo deixa de ser publicada. | article.unpublished |
| Artigo excluído | Um artigo foi excluído. | article.deleted |
| Artigo traduzido | Um artigo é traduzido automaticamente para um novo idioma. | article.translated |
| Reação adicionada | Um leitor reage a um artigo | article.reaction.added |
| A reação mudou. | Um leitor muda sua reação. | article.reaction.changed |
| Reação removida | Um leitor remove sua reação. | article.reaction.removed |
| Recebemos feedback sobre o artigo. | Um leitor envia um comentário por escrito sobre um artigo. | article.feedback.created |
| Categoria criada | Uma nova categoria, ou um novo idioma para uma categoria, é adicionada. | category.created |
| Categoria atualizada | O conteúdo de uma categoria muda durante uma sincronização. | category.updated |
| Categoria excluída | Uma categoria foi excluída. | category.deleted |
| Publicação da entrada no changelog | Um artigo na categoria de registro de alterações foi publicado. | changelog.published |
| Sincronização concluída | A sincronização com o Notion é concluída. | sync.completed |
| A sincronização falhou | A sincronização com o Notion falha. | sync.failed |
Os eventos article.updated e category.updated não são enviados quando apenas o status ou outras propriedades são alterados. Os eventos de categoria são enviados uma vez por idioma.
As reações e os comentários sobre os artigos são limitados a 120 eventos por minuto em cada central de ajuda. Eventos que excedam esse limite não serão enviados; portanto, utilize as análises da sua central de ajuda para verificar o total.
Configurações da central de ajuda
| No painel de controle | Evento | Enviado quando |
|---|---|---|
| Configurações da central de ajuda salvas | Uma configuração da central de ajuda foi salva. | site.updated |
| Código personalizado salvo | CSS ou JavaScript personalizado é salvo | site.custom_code.updated |
| Domínio personalizado verificado | Seu domínio personalizado começa a exibir a central de ajuda. | site.domain.verified |
| A verificação do domínio personalizado falhou. | Não foi possível acessar seu domínio personalizado. | site.domain.verification_failed |
| Integração atualizada | Uma integração é configurada, alterada, ativada ou desativada. | integration.updated |
| Noção conectada | A noção está conectada | notion.connected |
| Noção desconectada | A noção está desconectada. | notion.disconnected |
| Acesso ao Notion perdido | Notiondesk não consegue mais ler suas páginas do Notion. | notion.access_lost |
| Chatbot de IA atualizado | As configurações do chatbot são alteradas, ou ele é ativado ou desativado. | chatbot.updated |
| Adicionadas orientações ao chatbot | Um guia foi adicionado ao chatbot. | chatbot.guidance.created |
| Diretrizes para chatbots atualizadas | Alterações nas diretrizes | chatbot.guidance.updated |
| Orientações do chatbot excluídas | Uma orientação foi excluída. | chatbot.guidance.deleted |
| Redirecionamento adicionado | Um redirecionamento foi adicionado. | redirect.created |
| Redirecionamento atualizado | Uma mudança de redirecionamento | redirect.updated |
| Redirecionamento excluído | Um redirecionamento foi excluído. | redirect.deleted |
Os domínios personalizados são verificados regularmente, portanto, os eventos de domínio podem chegar alguns minutos após a alteração.
Espaço de trabalho
Os eventos do espaço de trabalho não estão vinculados a uma central de ajuda, portanto, seu site_id é null.
| No painel de controle | Evento | Enviado quando |
|---|---|---|
| Espaço de trabalho renomeado | O espaço de trabalho foi renomeado. | workspace.updated |
| Solicitação de ingresso recebida | Alguém pede para entrar no espaço de trabalho. | workspace.join_request.created |
| Solicitação de adesão aprovada | O pedido de adesão foi aprovado. | workspace.join_request.approved |
| Solicitação de adesão recusada | O pedido de adesão foi recusado. | workspace.join_request.declined |
| Colega de equipe convidado | Um colega de equipe é convidado | team_member.invited |
| Colega de equipe entrou | Um colega de equipe convidado aceita. | team_member.joined |
| A função do colega de equipe foi alterada. | A função de um colega de equipe muda. | team_member.role_changed |
| Companheiro de equipe ligado ou desligado | Um colega de equipe está ligado ou desligado. | team_member.status_changed |
| Colega de equipe removido | Um companheiro de equipe é removido | team_member.removed |
| Colega de equipe entrou | Um membro da equipe inicia sessão. Enviado apenas para o espaço de trabalho que ele abre por padrão. | team_member.logged_in |
| Chave de API criada | Uma chave de API foi criada. | api_key.created |
| Chave da API rotacionada | Uma chave de API é rotacionada. | api_key.rotated |
| Chave da API revogada | Uma chave de API foi revogada. | api_key.revoked |
| Central de ajuda criada | Um centro de ajuda foi criado. | site.created |
| Central de ajuda desativada | Um centro de ajuda é excluído, embora o espaço de trabalho ainda possua outro centro de ajuda online. | site.deleted |
Evento de teste
| No painel de controle | Evento | Enviado quando |
|---|---|---|
| Evento de teste | Você clica em Enviar evento de teste em um endpoint. | ping |
Você não pode selecionar ping na lista de eventos. Ele é enviado apenas para o endpoint que você está testando, o site_id dele é null, e ele é enviado apenas uma vez, sem novas tentativas.
O que cada solicitação contém
Notiondesk envia uma solicitação POST com um corpo JSON:
{
"id": "019a8f2e-4b1c-7d3e-9f40-5a6b7c8d9e01",
"event": "article.published",
"version": "2026-11-06",
"occurred_at": "2026-11-17T14:32:05+00:00",
"site_id": "019a8f2e-0b7d-7c3a-9e15-4f2a6b8c0d11",
"data": {
"article": {
"id": "1763391842",
"locale": "en",
"title": "Reset your password",
"slug": "reset-your-password",
"url": "https://help.acme-support.com/en/articles/reset-your-password",
"status": "published"
}
}
}| Campo | O que é isso? |
|---|---|
id | O ID do evento. Ele permanece o mesmo quando uma solicitação é repetida, portanto, use-o para identificar duplicatas. |
event | O nome do evento, por exemplo, article.published |
version | A versão deste formato de solicitação |
occurred_at | Quando o evento ocorreu, conforme a data e hora ISO 8601. |
site_id | A central de ajuda de onde o evento se origina, ou null para eventos do espaço de trabalho e o evento de teste. |
data | Os assuntos do evento. Veja o que os dados contêm . |
Cada solicitação também inclui estes cabeçalhos:
| Cabeçalho | Valor |
|---|---|
Content-Type | application/json |
User-Agent | ND-Webhooks/1.0 |
X-ND-Event | O nome do evento, o mesmo que event no corpo. |
X-ND-Delivery | O ID desta entrega para este endpoint. Ele permanece o mesmo em todas as tentativas. |
X-ND-Signature | A assinatura que comprova que a solicitação vem de Notiondesk. A verificação dessa assinatura é abordada em Verificar se um webhook vem de Notiondesk. |
Que dados contêm?
data contém um ou mais objetos, dependendo do evento:
| Evento | O que contém data |
|---|---|
contact_message.created | __PRESERVADO_218__: __PRESERVADO_217__, __PRESERVADO_216__, __PRESERVADO_215__, __PRESERVADO_214__, __PRESERVADO_213__, __PRESERVADO_212__ |
| __PRESERVADO_211__, __PRESERVADO_210__, __PRESERVADO_209__, __PRESERVADO_208__, __PRESERVADO_207__ | __PRESERVADO_206__: __PRESERVADO_205__, __PRESERVADO_204__, __PRESERVADO_203__, __PRESERVADO_202__, __PRESERVADO_201__, __PRESERVADO_200__ |
article.translated | article no novo idioma, e source_locale |
article.deleted | __PRESERVADO_195__: __PRESERVADO_194__ |
| __PRESERVADO_193__, __PRESERVADO_192__, __PRESERVADO_191__ | __PRESERVADO_190__: __PRESERVADO_189__, e __PRESERVADO_188__: __PRESERVADO_187__ |
article.feedback.created | __PRESERVADO_185__: __PRESERVADO_184__, e __PRESERVADO_183__: __PRESERVADO_182__, __PRESERVADO_181__, __PRESERVADO_180__, __PRESERVADO_179__, __PRESERVADO_178__ |
| __PRESERVADO_177__, __PRESERVADO_176__ | __PRESERVADO_175__: __PRESERVADO_174__, __PRESERVADO_173__, __PRESERVADO_172__, __PRESERVADO_171__ |
category.deleted | __PRESERVADO_169__: __PRESERVADO_168__ |
sync.completed | __PRESERVADO_166__: __PRESERVADO_165__, __PRESERVADO_164__, __PRESERVADO_163__, __PRESERVADO_162__ |
sync.failed | __PRESERVADO_160__: __PRESERVADO_159__, __PRESERVADO_158__ |
| __PRESERVADO_157__, __PRESERVADO_156__ | __PRESERVADO_155__: __PRESERVADO_154__, __PRESERVADO_153__, __PRESERVADO_152__ |
site.deleted | __PRESERVADO_150__: __PRESERVADO_149__ |
site.custom_code.updated | __PRESERVADO_147__: __PRESERVADO_146__ (__PRESERVADO_145__ ou __PRESERVADO_144__) |
| __PRESERVADO_143__, __PRESERVADO_142__ | __PRESERVADO_141__: __PRESERVADO_140__ |
integration.updated | __PRESERVADO_138__: __PRESERVADO_137__, __PRESERVADO_136__ |
| __PRESERVADO_135__, __PRESERVADO_134__, __PRESERVADO_133__ | Um objeto vazio, {} |
chatbot.updated | __PRESERVADO_130__: __PRESERVADO_129__, __PRESERVADO_128__, __PRESERVADO_127__ |
| __PRESERVADO_126__, __PRESERVADO_125__ | __PRESERVADO_124__: __PRESERVADO_123__, __PRESERVADO_122__, __PRESERVADO_121__, __PRESERVADO_120__ |
chatbot.guidance.deleted | __PRESERVADO_118__: __PRESERVADO_117__ |
| __PRESERVADO_116__, __PRESERVADO_115__ | __PRESERVADO_114__: __PRESERVADO_113__, __PRESERVADO_112__, __PRESERVADO_111__, __PRESERVADO_110__, __PRESERVADO_109__ |
redirect.deleted | __PRESERVADO_107__: __PRESERVADO_106__ |
workspace.updated | __PRESERVADO_104__: __PRESERVADO_103__, __PRESERVADO_102__ |
| __PRESERVADO_101__, __PRESERVADO_100__, __PRESERVADO_99__ | __PRESERVADO_98__: __PRESERVADO_97__, __PRESERVADO_96__, __PRESERVADO_95__ |
| __PRESERVADO_94__, __PRESERVADO_93__, __PRESERVADO_92__, __PRESERVADO_91__ | __PRESERVADO_90__: __PRESERVADO_89__, __PRESERVADO_88__, __PRESERVADO_87__, __PRESERVADO_86__ |
team_member.removed | __PRESERVADO_84__: __PRESERVADO_83__ |
team_member.logged_in | __PRESERVADO_81__: __PRESERVADO_80__, __PRESERVADO_79__, __PRESERVADO_78__ |
| __PRESERVADO_77__, __PRESERVADO_76__ | __PRESERVADO_75__: __PRESERVADO_74__, __PRESERVADO_73__, __PRESERVADO_72__, __PRESERVADO_71__, __PRESERVADO_70__ |
api_key.rotated | api_key para a nova chave e previous_api_key: id |
ping | message |
data nunca contém anexos, segredos, código personalizado ou detalhes de faturamento.
Dados de exemplo por família de eventos
Esses exemplos mostram apenas data. O restante da solicitação é o mesmo para todos os eventos.
Formulário de contato, contact_message.created:
Artigos, __PRESERVADO_60__:
status é o status desse idioma: draft, review, published, archived ou translation source. url pode ser null se a central de ajuda ainda não tiver um endereço.
Reações e feedback, article.feedback.created:
Para reações, reaction.type é smiley, neutral_face ou disappointed. As centrais de ajuda que exibem botões de polegar para cima enviam smiley para Sim e disappointed para Não. Em feedback, article.id é null quando o artigo não existe mais.
Categorias, __PRESERVADO_42__:
Sincronizações, sync.completed e sync.failed:
trigger é manual, api ou automatic. reason é pages_failed quando algumas páginas não puderam ser sincronizadas, ou failed quando a sincronização foi interrompida.
Configurações da central de ajuda, redirect.created:
Espaço de trabalho e colegas de equipe, team_member.role_changed:
role é admin, editor, billing_manager ou viewer. status é enabled, disabled ou pending_invite.
Chaves de API, api_key.rotated:
Evento de teste, ping:
Gerencie os eventos no seu receptor.
{
"contact_message": {
"id": "019a8f31-5c2e-7a41-8b9d-2e6f0a7c4b23",
"name": "Jamie Rivera",
"email": "[email protected]",
"subject": "Invoice question",
"message": "Hi, where can I download my latest invoice?",
"locale": "en"
}
}{
"article": {
"id": "1763391842",
"locale": "fr",
"title": "Réinitialiser votre mot de passe",
"slug": "reinitialiser-votre-mot-de-passe",
"url": "https://help.acme-support.com/fr/articles/reinitialiser-votre-mot-de-passe",
"status": "published"
},
"source_locale": "en"
}{
"article": { "id": "1763391842" },
"feedback": {
"id": "019a8f33-8d4f-7b52-a1c3-6e9b2d0f7a35",
"name": "Sam Lee",
"email": "[email protected]",
"message": "The screenshots don't match the new settings page.",
"locale": "en"
}
}{
"category": {
"id": "1763392017",
"locale": "en",
"name": "Billing",
"slug": "billing"
}
}{
"sync": {
"trigger": "automatic",
"duration_seconds": 42,
"pages_synced": 120,
"pages_updated": 3
}
}{
"sync": {
"reason": "pages_failed",
"pages_processed": 118
}
}{
"redirect": {
"id": "019a8f35-2a6c-7d63-b4e8-0c1f5a9d3e47",
"source_path": "/old-help/reset-password",
"type": "article",
"article_id": "1763391842",
"category_id": null
}
}{
"team_member": {
"id": "019a8f37-7e1b-7f74-8c2d-9a4e6b1f0c59",
"email": "[email protected]",
"role": "editor",
"status": "enabled"
}
}{
"api_key": {
"id": "019a8f39-3f8a-7185-9d6e-1b7c4e2a8d6b",
"prefix": "nd_wsk_4fa9c2e17b30",
"label": "CRM sync",
"scopes": ["read"],
"expires_at": null
},
"previous_api_key": { "id": "0199c4d2-6b3e-7296-ae0f-5d8a1c7e9b7d" }
}{
"message": "Test event from Notiondesk."
}- Responda rapidamente. Retorne primeiro qualquer código de status
2xxe, em seguida, execute a tarefa. Notiondesk aguarda 5 segundos para que seu servidor comece a responder e 10 segundos no total, lendo apenas o código de status.
- Espere duplicatas. O mesmo evento pode chegar mais de uma vez, por exemplo, após uma nova tentativa. Ignore qualquer evento
idque você já tenha processado.
- Não confie na ordem. Os eventos podem ocorrer fora de ordem. Use
occurred_atquando a ordem for importante.
- Os dados são lidos como o estado mais recente. O atributo
dataé lido quando o evento é enviado, portanto, duas alterações rápidas em um artigo podem ambas conter a versão mais recente. Se o item já tiver sido removido nesse momento, o evento é ignorado.
Perguntas frequentes
Eu recebo o conteúdo completo do artigo?
Não. Os eventos de artigos contêm o título, o slug, a URL e o status. Use a API Notiondesk se precisar de mais informações.
Como posso saber de qual central de ajuda um evento se origina?
Leia site_id. É o ID da central de ajuda ou null para eventos do espaço de trabalho e o evento de teste.
Por que não recebi um evento para cada reação?
As reações e os comentários sobre os artigos são limitados a 120 eventos por minuto em cada central de ajuda. Eventos que excedam esse limite não serão enviados. Consulte as análises da sua central de ajuda para obter os totais.
Posso receber o mesmo evento duas vezes?
Sim, por exemplo, após uma nova tentativa. O valor id permanece o mesmo, então ignore aquele que você já processou.
O que significa versão?
Isso indica qual formato de solicitação foi usado. As solicitações atualmente usam 2026-11-06.