--- title: "Webhooks do CustomerX" description: "Saiba como funcionam os webhooks no CustomerX." url: https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx collection: "Configurações" updated: 2026-10-22 language: pt-br --- # Webhooks do CustomerX Saiba como funcionam os webhooks no CustomerX. ## **Neste artigo:** - [Introdução](https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx.md#heading-1-introdu-o) - [Overview](https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx.md#heading-2-overview) - [Como cadastrar um novo webhook](https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx.md#heading-3-como-cadastrar-um-novo-webhook) - [Logs do webhook](https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx.md#heading-4-logs-de-webhook) - [Eventos](https://ajuda.customerx.com.br/pt-br/articles/104-webhooks-do-customerx.md#heading-5-eventos) ## **Introdução** Você com certeza já deve ter ouvido falar sobre webhooks. Mas afinal, o que são e para que servem? Webhooks são mecanismos de comunicação entre sistemas na web que permitem que um aplicativo envie informações automaticamente para outro aplicativo sempre que um determinado evento ocorre. Quando um evento ocorre, o aplicativo emissor envia uma mensagem HTTP para o webhook, que contém informações relevantes sobre o evento. O aplicativo receptor pode então usar essas informações para atualizar seu próprio estado ou tomar alguma outra ação automatizada com base nessa atualização. O CustomerX conta com webhooks **a partir do plano Growth** e neste artigo vamos detalhar as funções desse poderoso recurso. ## **Overview** Você pode encontrar o recurso de webhooks clicando na engrenagem presente no canto superior direito e em seguida na opção "Webhooks". ![](https://staticfiles.gleap.io/ghelparticle/Gqyho9FGmnitAsOkqE1mj0VFqPvPBf0MTrKwQZwcKDSWs24zj34Temli7oAnkMC8H6o0Tm7Aib2.png) Na tela de listagem de webhooks são exibidos todos os webhooks, juntamente com informação do tipo de evento, data de criação e status atual. Além disso também há uma opção para pesquisar um webhook específico caso desejado. ![](https://staticfiles.gleap.io/ghelparticle/pVLxJuf6rWd7NqC3Ghifa7FBP8dWx555CVfjFlxli6kOlBBrMe7ZAL23uSdyi2EY43rbX6OuGUf.png) Clicando no botão "Opções" você também pode ver detalhes, editar, inativar ou excluir o webhook. ## **Como cadastrar um novo webhook** Para cadastrar um novo webhook, basta seguir os seguintes passos: Na tela de listagem de webhooks, clique em "Novo Webhook" e no cadastro de webhook, preencha os seguintes campos: 1. Descrição: informação que identifica o webhook. 2. Tipo de evento: escolha se deseja que o webhook seja disparado quando um registro for adicionado, atualizado, deletado ou qualquer evento. 3. Evento: escolha o objeto que deseja enviar entre cliente, contato, ticket, financeiro, tarefas da jornada do cliente e tarefas do CSM. 4. URL: informe a URL para qual será enviado o evento. 5. Usuário e Senha: caso possua autenticação, informe as credenciais do destino para que o webhook consiga se comunicar com sucesso. 6. Clique em "Salvar Webhook" e seu webhook será criado. ![](https://staticfiles.gleap.io/ghelparticle/XjbIAXVmHRhxjUa5PxZFQwNpQotFoZpcyEpAyi2phKwa8ZtMlwF4PdKSrU0lo8Lm930LWZ1eZFP.png) ## **Logs de webhook** Após o cadastro de um novo webhook, a primeira dúvida mais comum é "como saber se meu webhook está funcionando?". Para isso temos a opção de log dos disparos do webhook. Você pode acessar essa tela através da listagem de webhooks, clicando no botão "Opções" do webhook desejado e selecionando a opção "Detalhes". ![](https://staticfiles.gleap.io/ghelparticle/97vs9pbCFKGhTcmfkS1Fc3K36q9owp1aQIFhnFxR7FOfhUBR1ysaF9y9FJxm8QfpkTle6dfRP37.png) Na primeira parte da tela de detalhes do webhook temos as informações básicas do webhook cadastrado, sendo elas: descrição, status, tipo de evento, evento, URL, usuário, senha, data de criação e quem criou. ![](https://staticfiles.gleap.io/ghelparticle/GfljkRWW9Acxsy9nHr7gK6cW4cUZpeAIbGDyxWQhsq0flPxYVmNgFK00czW1T7lq4VMzwpckjS1.png) Logo abaixo, temos presente os logs de envio, onde é apresentado: 1. Evento (Id): cada disparo do webhook gera um registro, aqui é exibido o identificador único do disparo. 2. Resposta/Status: representa a resposta recebida do destino após tentativa de comunicação. O código da resposta segue o código de status de resposta http, mas para facilitar o entendimento, caso esteja verde, significa que foi recebido com sucesso e vermelho houve algum problema na recepção. 3. Data do envio: data e hora em que o webhook foi disparado. ![](https://staticfiles.gleap.io/ghelparticle/GEckrvXcuf4yOAhdzAOXOGZcgYz0ouGpzqQcvP9pxAcg5a4wq2qqwkQSA1XkIJlHHkyVDyocaSo.png) Ao clicar sobre um evento, são exibidos maiores detalhes do evento como: 1. Resposta: exibe a resposta recebida da URL destino. 2. Envio: apresenta detalhes do envio como id do evento, tipo do evento, evento e os dados enviados. **Importante:** caso algum webhook tenha muitas falhas consecutivas, o criador do webhook receberá um e-mail informando e se as falhas persistirem o webhook será inativado automaticamente. ## **Eventos** Para cada evento é disparado um objeto com diversos dados informados. Abaixo estão documentados os dados enviados para cada evento bem como exemplos de corpo de cada disparo. #### Cliente 1. external\_id\_client: código do cliente 2. company\_name: razão social 3. trading\_name: fantasia 4. cnpj\_cpf: CNPJ ou CPF 5. ie\_rg: inscrição estadual ou CPF 6. date\_register: data de registro 7. email: e-mail 8. cep: cep 9. state: estado 10. city: cidade 11. street: rua 12. branch\_type: tipo de filial 13. district: rua 14. number: número 15. complement: complemento 16. facebook: link do facebook 17. linkedin: link do linkedin 18. twitter: link do twitter 19. instagram: link do instagram 20. youtube: link do youtube 21. site: link do site 22. parent\_client\_id: id da empresa matriz 23. parent\_company: define se a empresa é matriz ou não (true or false) 24. only\_journey\_by\_contract: parametro que define vinculo de jornada apenas por contrato 25. country: país 26. client\_service\_id: código da categoria de serviço 27. client\_segment\_id: código da categoria de segmento 28. client\_group\_id: código da categoria de grupo 29. quote\_currency\_id: código da moeda utilizada 30. phone: telefone 31. cancellation\_date: data de cancelamento 32. created\_at: data de criação 33. updated\_at: data de atualização 34. is\_excluded: define se o cliente foi excluído (true ou false) 35. exclusion\_date: data de exclusão 36. contract\_status: status do contrato 37. integration: dado da integração caso tenha sido importado de algum software terceiro 38. deleted\_at: data de exclusão 39. origin: código da integração de origem **Exemplo:** ```javascript {" "id":999, "external_id_client":"9999", "company_name":"Exemplo Razão Social", "trading_name":"Exemplo Fantasia", "cnpj_cpf":"12.345.678/0001-00", "ie_rg":"0000000000", "date_register":"2022-02-07T00:00:00.000-03:00", "email":"exemplo@exemplo.com.br", "cep":"00000000", "state":"PR", "city":"Curitiba", "street":"Rua Exemplo", "branch_type":"independent", "district":"Centro", "number":"9999", "complement":"exemplo", "facebook":"www.link.com/exemplo", "linkedin":"www.link.com/exemplo", "twitter":"www.link.com/exemplo", "instagram":"www.link.com/exemplo", "youtube":"www.link.com/exemplo", "site":"www.link.com/exemplo", "parent_client_id":null, "parent_company":true, "only_journey_by_contract":false, "country":"Brasil", "client_service_id":1, "client_segment_id":1, "client_group_id":1, "quote_currency_id":1, "phone":"+5545123456789", "cancellation_date":null, "created_at":"2022-02-08T09:08:28.490-03:00", "updated_at":"2022-08-10T16:25:15.679-03:00", "is_excluded":false, "exclusion_date":null, "contract_status":"active_contract", "integration":{"pipedrive_id":9999}, "deleted_at":null, "origin":9} ``` #### Contato 1. id: código do contato 2. name: nome do contato 3. email: e-mail do contato 4. occupation: cargo 5. birthday: data de nascimento 6. is\_principal: define se é o contato principal (true ou false) 7. type\_contact\_id: código do tipo de contato 8. client\_id: código interno do cliente 9. external\_id\_contact: código do cliente 10. note: observação 11. platform\_active\_user: define se o contato é usuário da plataforma 12. phone\_fix: telefone  13. phone\_cel: celular 14. role: cargo 15. created\_at: data de criação 16. updated\_at: data de atualização 17. integration: dados da integração de origem 18. deleted\_at: data de exclusão (caso tenha sido excluido) 19. origin: código da integração de origem **Exemplo:** ```javascript { id: 4716 name: "Nome Exemplo" email: "nome@exemplo.com.br" occupation: "Cargo de exemplo" birthday: "01/01/1990" is_principal: true type_contact_id: 99 client_id: 999 external_id_contact: "ABC123" note: "Exemplo" platform_active_user: true phone_fix: "45999999999" phone_cel: "45999999999" role: "Exemplo" created_at: "2022-08-26T14:21:06.975-03:00" updated_at: "2023-03-14T14:45:00.490-03:00" integration:"pipedrive_id: 0000" deleted_at: null origin: 9} ``` #### Ticket 1. id: identificador interno do ticket no CustomerX 2. external\_id: Identificador do ticket 3. title: Título do ticket aberto 4. description: Descrição do ticket 5. comment: Comentários do ticket 6. type\_ticket: Tipo do ticket, ex: (BUG, ERRO, AJUDA, ...) 7. priority: Prioridade desse ticket 8. attendant\_name: Nome do analista/atendente que prestará ajuda ao cliente 9. attendant\_email: E-mail do analista/atendente que prestará ajuda ao cliente 10. date\_opening: Data que foi aberto o ticket 11. date\_reopening: Data de reabertura, caso o ticket foi reaberto 12. date\_closing: Data em que o ticket foi fechado, caso o ticket já foi fechado 13. date\_finalized: Data em que o ticket foi finalizado 14. date\_deadline\_attendance: Data do prazo para o ticket ser atendido 15. date\_deadline\_closing: Data do prazo para o ticket ser fechado 16. status: Status com base nos que foram descrito acima 17. created\_at: data de criação 18. updated\_at: data de atualização 19. client\_id: código interno do cliente no CustomerX 20. contact\_id: código interno do contato no CustomerX 21. group\_name: nome do grupo 22. group\_id: código do grupo 23. integration\_url: URL do ticket na plataforma de origem 24. integration\_url\_label: "Alias" da URL do ticket, texto que será exibido na plataforma CustomerX e direcionará ao Ticket. 25. integration: dados adicionais da integração de origem 26. deleted\_at: data de exclusão 27. origin: 33 **Exemplo:** ```javascript { id: 9999 external_id: "0001" title: "Conversa com João" description: "Conversa com João" comment: "Ticket sem comentário" type_ticket: "Ticket" priority: null attendant_name: null attendant_email: null date_opening: "2023-03-14T10:37:18.000-03:00" date_reopening: null date_closing: null date_finalized: null date_deadline_attendance: null date_deadline_closing: null status: "open" created_at: "2023-03-14T10:37:21.168-03:00" updated_at: "2023-03-14T10:37:21.168-03:00" client_id: 999 contact_id: 500 group_name: null group_id: null integration_url: "https://helpdesk.com/tickets/AAA" integration_url_label: "9999" integration: "zendesk:ticket_id: 9999" deleted_at: null origin: 33} ``` #### Financeiro 1. external\_id\_financial: ID externo da movimentação 2. identifier: Identificador único da movimentação 3. description: Descrição para a movimentação 4. date\_issue: Data de emissão 5. date\_due: Data de vencimento da movimentação 6. value: Valor da movimentação 7. date\_payment: Data de pagamento 8. discount\_value: Valor de desconto (quando aplicado) 9. amount\_paid: Valor pago 10. status: Status com base nos que descrito acima (pending, received, canceled, excluded) **Exemplo:** ```javascript {"external_id_financial": "99999999","external_id_client": "49","identifier": "99999999","description": "Atrasada","date_issue": "02/04/2022","date_due": "02/04/2022","date_payment": "nil","value": 1000.00,"discount_value": 0.0,"status": "pending"} ``` #### Tarefa da jornada 1. id: código interno da tarefa; 2. description: descrição da tarefa; 3. title: título da tarefa; 4. date\_closure: data de conclusão; 5. date\_scheduled: data inicio agendada; 6. status: status da tarefa; 7. position: posição na lista; 8. created\_at: data de criação; 9. updated\_at: data de atualização; 10. customers\_follow\_up\_id: código da lista da jornada; 11. user\_id: código do usuário; 12. date\_scheduled\_final: data fim agendada; 13. contact\_id: código do contato; 14. fixed\_value: define se há pontuação fixa para esta tarefa; 15. value: pontos da tarefa; 16. default\_tasks\_follow\_up\_id: código da tarefa modelo; 17. late\_task\_sidekiq\_job\_id: código de controle interno; 18. creator\_id: código do usuário que criou a tarefa; 19. reporter\_id: código do usuário relator; 20. deleted\_at: data de exclusão; 21. client: dados do cliente vinculado a tarefa 1. extenal\_id\_client: código do cliente 2. company\_name: razão social do cliente 3. trading\_name: nome fantasia do cliente 4. email: e-mail 5. cnpj\_cpf: CNPJ ou CPF 22. user: dados do usuário atrelado a tarefa 1. id: código 2. name: nome 3. email: e-mail 23. reporter: dados do relator atrelado a tarefa 1. id: código 2. name: nome 3. email: e-mail 24. creator: dados do criador da tarefa 1. id: código 2. name: nome 3. email: e-mail 25. step: nome da lista da jornada 1. description: descrição da etapa 2. position: posição da lista na jornada 26. journey: dados da jornada 1. id: código da jornada 2. description: descrição da jornada 27. default\_journey\_id: código da jornada padrão 28. products: produtos atrelados a jornada **Exemplo:** ```javascript { id: 19604 description: null title: "Título Exemplo" date_closure: null date_scheduled: null status: true position: 31 created_at: "2023-03-14T13:35:02.884-03:00" updated_at: "2023-03-14T13:35:02.884-03:00" customers_follow_up_id: 2602 user_id: 999 date_scheduled_final: null contact_id: null fixed_value: false value: "0.0" default_tasks_follow_up_id: null late_task_sidekiq_job_id: null creator_id: 569 reporter_id: 569 deleted_at: null client: extenal_id_client: "2903" company_name: "Exemplo razão social" trading_name: "Exemplo fantasia" email: "exemplo@email.com.br" cnpj_cpf: "12.345.678/0001-00" user: id: 569 name: "João Exemplo" email: "joao@exemplo.com" reporter: id: 569 name: "João Exemplo" email: "joao@exemplo.com" creator: id: 569 name: "João Exemplo" email: "joao@exemplo.com" step: description: "Engage" position: 4 journey: id: 999 description: "Ongoing" default_journey_id: 9 products:null} ``` #### Tarefa do board de tarefas 1. title: Título da Tarefa 2. description: Descrição da Tarefa 3. date\_scheduled: Data de início da Tarefa 4. client\_id: ID interno do cliente 5. dashboard\_activities\_step\_id: ID do tipo de contato  6. date\_scheduled\_final: Data de início da Tarefa 7. date: Data da Tarefa (data de conclusão) 8. contact\_id: código do contato 9. reporter\_id: código do relator 10. filing\_date: data de arquivamento 11. user\_id: código do usuário 12. id: código interno da tarefa 13. status: Status da Tarefa (true/false) 14. created\_at: data de criação 15. updated\_at: data de atualização 16. position: Posição da Tarefa na lista do board, ordenado por ordem crescente 17. is\_filed: booleano, define es a tarefa está arquivada 18. creator\_id: código do criador da tarefa 19. deleted\_at: data de exclusão 20. user: dados do usuário **Exemplo:** ```javascript { title: "Exemplo" description: "Exemplo" date_scheduled: null client_id: null dashboard_activities_step_id: 135 date_scheduled_final: null date: "2023-03-15T14:53:35.262-03:00" contact_id: null reporter_id: 1 filing_date: null user_id: 1 id: 2126 status: true created_at: "2023-02-16T15:24:08.098-03:00" updated_at: "2023-03-15T14:53:35.913-03:00" position: 1 is_filed: false creator_id: 1 deleted_at: null user: id: 1 name: "João Exemplo" email: "joao@exemplo.com"} ```