Como funcionam os webhooks
Este artigo mostra como configurar um webhook para sua organização da GDASH. Isso permite que seu sistema particular receba notificações em tempo real sempre que alguma mudança seja realizada em um de seus objetos geridos. Tais como: Atividades, Negócios, Chamados, etc.
Acesse a página de gerenciamento de chave de API e configurações de webhooks ou clique aqui para acessar.
Procure pela listagem de webhooks e toque em "Adicionar webhook"
Configure o webhook com um nome, a URL do seu serviço online para o recebimento das notificações e, por fim, os eventos que deseja enviar como notificação para seu sistema. Deixe o webhook ativado.
Após a criação, o webhook deverá aparecer na listagem. 
Toque no webhook criado para copiar a chave gerada automaticamente. Esta chave será útil para que seu sistema online consiga identificar que o webhook recebido é referente aos eventos da GDASH. Você pode renovar esta chave sempre que for preciso.
Pronto! Simples assim seu webhook está configurado. Veja a seção a seguir para entender melhor como os webhooks funcionam.
Sempre que ocorre um evento em algumas de seus objetos, a plataforma da GDASH identifica o evento e envia uma notificação à URL do webhook especificada por você. Você pode receber diversos tipos de notificações tais como: negócio criado, atualizado, deletado entre outros.
Todos os Webhooks têm o seguinte formato genérico:
<entity> será sempre um dos seguintes: 'task', 'person', 'company', 'deal', 'ticket' e 'product'. Ela se refere ao objeto criado, atualizado ou deletado.
event será sempre um dos seguintes: 'task_created', 'task_updated', 'task_deleted', 'person_created', 'person_updated', 'person_deleted', 'company_created', 'company_updated', 'company_deleted', 'deal_created', 'deal_updated', 'deal_deleted', 'deal_status_changed', 'deal_phase_changed', 'ticket_created', 'ticket_updated', 'ticket_deleted', 'ticket_status_changed', 'product_created', 'product_updated', 'product_deleted'
O conteúdo de <entity> vai variar conforme o evento disparado. Veja abaixo todos os conteúdos possíveis com base em seus eventos.
task_created e task_updated: disparado quando uma atividade é criada ou atualizada, respectivamente, na GDASH.
task_deleted: disparado quando uma atividade é deletada da GDASH.
person_created e person_updated : disparado quando uma pessoa é criada ou atualizada, respectivamente, na GDASH.
person_deleted: disparado quando uma pessoa é deletada na GDASH.
company_created e company_updated: disparado quando uma empresa é criada ou atualizada, respectivamente, na GDASH.
company_deleted: disparado quando uma empresa é excluída da GDASH.
deal_created e deal_updated: disparado quando um negócio é criado ou atualizado, respectivamente, na GDASH.
deal_deleted: disparado quando um negócio é deletada da GDASH.
deal_phase_changed: disparado quando um negócio muda de fase na GDASH.
deal_status_changed: disparado quando o status de um negócio é alterado na GDASH.
ticket_created e ticket_updated: disparado quando um chamado é criado ou atualizado, respectivamente, na GDASH.
ticket_deleted: quando um chamado é deletado da GDASH.
ticket_status_changed: disparado quando o status de um chamado é alterado na GDASH.
product_created e product_updated: disparado quando um produto é criado ou atualizado, respectivamente, na GDASH.
product_deleted: quando um produto é deletado da GDASH.
Como configurar um webhook
Acesse a página de gerenciamento de chave de API e configurações de webhooks ou clique aqui para acessar.
Procure pela listagem de webhooks e toque em "Adicionar webhook"

Configure o webhook com um nome, a URL do seu serviço online para o recebimento das notificações e, por fim, os eventos que deseja enviar como notificação para seu sistema. Deixe o webhook ativado.


Toque no webhook criado para copiar a chave gerada automaticamente. Esta chave será útil para que seu sistema online consiga identificar que o webhook recebido é referente aos eventos da GDASH. Você pode renovar esta chave sempre que for preciso.

Pronto! Simples assim seu webhook está configurado. Veja a seção a seguir para entender melhor como os webhooks funcionam.
Como funcionam os webhooks
Sempre que ocorre um evento em algumas de seus objetos, a plataforma da GDASH identifica o evento e envia uma notificação à URL do webhook especificada por você. Você pode receber diversos tipos de notificações tais como: negócio criado, atualizado, deletado entre outros.
Todos os Webhooks têm o seguinte formato genérico:
{
event: 'Evento realizado (exemplo: task_created).',
secret: 'A chave gerada automáticamente pelo sistema que pode ser vista no modal de configurações do webhook',
payload: {
'<entity>': {
// payload específico do evento.
},
triggered_by: {
id: 'O ID do usuário da GDASH que disparou o evento.',
name: 'Nome do usuário da GDASH que disparou o evento',
},
},
}
<entity> será sempre um dos seguintes: 'task', 'person', 'company', 'deal', 'ticket' e 'product'. Ela se refere ao objeto criado, atualizado ou deletado.
event será sempre um dos seguintes: 'task_created', 'task_updated', 'task_deleted', 'person_created', 'person_updated', 'person_deleted', 'company_created', 'company_updated', 'company_deleted', 'deal_created', 'deal_updated', 'deal_deleted', 'deal_status_changed', 'deal_phase_changed', 'ticket_created', 'ticket_updated', 'ticket_deleted', 'ticket_status_changed', 'product_created', 'product_updated', 'product_deleted'
O conteúdo de <entity> vai variar conforme o evento disparado. Veja abaixo todos os conteúdos possíveis com base em seus eventos.
Atividades
task_created e task_updated: disparado quando uma atividade é criada ou atualizada, respectivamente, na GDASH.
task: {
id: string, // Identificador único da atividade
type: string, // Tipo da atividade
note: string, // Descrição ou nota da atividade
assignee: {
id: string, // Identificador do responsável pela atividade
name: string // Nome do responsável
},
due_date: Date, // Data de vencimento da atividade
priority: string, // Prioridade da atividade (LOW, MEDIUM, HIGH)
deal_id: string | null, // ID do negócio associado (se houver)
ticket_id: string | null, // ID do ticket associado (se houver)
people_id: string | null, // ID da pessoa associada (se houver)
company_id: string | null, // ID da empresa associada (se houver)
custom_fields: array, // Campos personalizados associados à atividade
status: string, // Status da atividade ('done' ou 'undone')
created_at: Date, // Data de criação da atividade
}
task_deleted: disparado quando uma atividade é deletada da GDASH.
task: {
id: string, // Identificador único da atividade
title: string // Tipo da atividade
}
Pessoas
person_created e person_updated : disparado quando uma pessoa é criada ou atualizada, respectivamente, na GDASH.
person: {
id: string, // Identificador único da pessoa
first_name: string | null, // Nome
last_name: string | null, // Sobrenome
email: string | null, // Endereço de e-mail
phone: string | null, // Número de telefone
cpf: string | null, // CPF
company: object | null, // Empresa associada
tags: array | null, // Tags da pessoa
custom_fields: array | null, // Campos personalizados
assignees: array | null // Array de usuários atribuídos
}
person_deleted: disparado quando uma pessoa é deletada na GDASH.
person: {
id: string // Identificador único da pessoa
}
Empresas
company_created e company_updated: disparado quando uma empresa é criada ou atualizada, respectivamente, na GDASH.
company: {
id: string, // Identificador único da empresa
name: string, // Nome da empresa
cnpj: string | null, // CNPJ da empresa
corporate_reason: string | null, // Razão social
zip_code: string | null, // CEP
street: string | null, // Rua
district: string | null, // Bairro
number: string | null, // Número
city: string | null, // Cidade
state: string | null, // Estado
email: string | null, // E-mail da empresa
phone: string | null, // Telefone fixo
mobile_phone: string | null, // Telefone celular
assignees: array, // Array de usuários atribuídos
tags: array, // Tags da empresa
industry: string | null, // Setor da empresa
custom_fields: array | null, // Campos personalizados
website: string | null // Site da empresa
}
company_deleted: disparado quando uma empresa é excluída da GDASH.
company: {
id: string // Identificador único da empresa
}
Negócios
deal_created e deal_updated: disparado quando um negócio é criado ou atualizado, respectivamente, na GDASH.
deal: {
id: string, // Identificador único do negócio
name: string, // Nome do negócio
pipeline_id: string, // Identificador do funil
phase_id: string, // Identificador da fase
amount: number, // Valor do negócio (padrão 0)
assignees: array, // Array de usuários atribuídos
start_date: Date, // Data de início
end_date: Date | null, // Data de término
estimated_closing_date: Date | null, // Data prevista de fechamento
products: array, // Produtos associados
customers: array, // Clientes associados
companies: array, // Empresas associadas
people: array, // Pessoas associadas
plants: array, // Plantas associadas
status: string, // Status do negócio
loss_reason: string | null, // Motivo da perda
loss_description: string | null, // Descrição da perda
custom_fields: array | null, // Campos personalizados
tags: array | null // Tags do negócio
}
deal_deleted: disparado quando um negócio é deletada da GDASH.
deal: {
id: string // Identificador único do negócio
}
deal_phase_changed: disparado quando um negócio muda de fase na GDASH.
deal: {
id: string, // Identificador único do negócio
before: {
pipeline_id: string, // Identificador do funil anterior
phase_id: string // Identificador da fase anterior
},
after: {
pipeline_id: string, // Novo identificador do funil
phase_id: string // Novo identificador da fase
}
}
deal_status_changed: disparado quando o status de um negócio é alterado na GDASH.
deal: {
id: string, // Identificador único do negócio
before: {
status: string // Status anterior
},
after: {
status: string // Novo status
}
}
Chamados
ticket_created e ticket_updated: disparado quando um chamado é criado ou atualizado, respectivamente, na GDASH.
ticket: {
id: string, // Identificador único do chamado
title: string | null, // Título do chamado
description: string | null, // Descrição do chamado
status: string, // Status do chamado
priority: string, // Prioridade do chamado
type: string, // Tipo do chamado
tags: array, // Tags do chamado
plant_id: string | null, // ID da usina associada
requester: {
id: string | null, // Identificador do solicitante
name: string | null // Nome do solicitante
},
assignee: {
id: string | null, // Identificador do responsável
name: string | null // Nome do responsável
}
}
ticket_deleted: quando um chamado é deletado da GDASH.
ticket: {
id: string // Identificador único do chamado
}
ticket_status_changed: disparado quando o status de um chamado é alterado na GDASH.
ticket: {
before: {
status: string // Status anterior
},
after: {
status: string // Novo status
}
}
Produtos
product_created e product_updated: disparado quando um produto é criado ou atualizado, respectivamente, na GDASH.
product: {
id: string, // Identificador único do produto
name: string, // Nome do produto
description: string, // Descrição do produto
price: number, // Preço do produto
custom_fields: array // Campos personalizados
}
product_deleted: quando um produto é deletado da GDASH.
product: {
id: string // Identificador único do produto
}
Atualizado em: 17/01/2025
Obrigado!