A integração via Webhook do CXM de Atendimento permite enviar automaticamente para outros sistemas os dados dos atendimentos realizados na plataforma, como quando uma conversa é finalizada.
Com isso, é possível automatizar processos, alimentar bancos de dados externos, integrar com CRMs ou registrar históricos de atendimento em tempo real, sem ações manuais.
Cada gatilho do webhook possui um payload próprio, definido nas configurações de parâmetros da filial.
Atualmente, a documentação aborda apenas o webhook de atendimentos. Para outros gatilhos, é necessário contatar o time de suporte da PipeRun.
Atenção! Este recurso requer conhecimentos técnicos em programação, pois a configuração é feita por meio de JSON.
Neste artigo, você encontrará a descrição detalhada de cada campo presente nos objetos enviados pelo webhook de atendimento, além de exemplos de payloads para auxiliar na configuração e integração com outros sistemas.
Para acessar a documentação completa do Webhook de atendimentos clique aqui.
TÓPICOS DO ARTIGO
- Especificações gerais
- Objeto principal [talk]
- Objeto mensagem do atendimento [TalkHistory]
- Objeto tipo de anexo [AttachmentType]
- Objeto usuário [User]
- Objeto canal [Channel]
- Objeto cliente [Customer]
- Objeto informações de perfil do cliente [ProfileInfo]
- Objeto campo customizado do cliente [CustomerCustomField]
- Objeto telefone do cliente [CustomerTelephone]
- Objeto e-mail do cliente [CustomerEmail]
- Objeto tabulação do atendimento [TalkEvent]
- Objeto evento de tabulação [Event]
- Objeto variável do bot [BotVariable]
- Objeto bot [Bot]
- Como configurar a integração via webhook
ESPECIFICAÇÕES GERAIS
Gatilho: O WebHook é disparado quando um atendimento é finalizado no CXM.
Conteúdo enviado: A requisição contém o objeto principal talk, que representa o atendimento, acompanhado de outros objetos relacionados:
- talk: dados do atendimento
- talkHistory: histórico de mensagens do atendimento;
- talkHistory->attachmentType: tipo de anexo;
- talkHistory->channel: dados do canal de atendimento;
- talkHistory->user: dados do usuário que enviou ou recebeu a mensagem;
- customer: dados do cliente;
- customer->profileInfo: informações referentes ao perfil do cliente no Facebook ou Instagram;
- customerCustomField: campos customizados criados para o cadastro do cliente;
- customerTelephone: dados referente ao telefone do cliente;
- customerEmail: dados referente ao e-mail do cadastro do cliente;
- talkEvent: lista de tabulações registradas nos atendimento;
- talkEvent->event: lista de tabulações cadastradas no sistema;
- botVariable: lista das variáveis capturadas pelo Bot que efetuou o pré-atendimento;
- bot: dados do Bot que efetuou o pré-atendimento;
OBJETO PRINCIPAL [TALK]
| Campo | Obrigatório | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do atendimento; |
| customer_id int | NÃO | Identificador interno do cliente; |
| agent_id int | SIM | Identificador interno do agente; |
| queue_id int | SIM | Identificador interno da fila de atendimento; |
| channel_id int | NÃO | Identificador interno do canal; |
| priority_id int | NÃO | Identificador interno da prioridade; |
| finished_at datetime | SIM | Data/hora da finalização do atendimento; |
| was_success bool | NÃO | Flag para identificar se o atendimento foi encerrado por uma tabulação positiva ou não; |
| created_at datetime | NÃO | Data/hora do início do atendimento; |
| has_schedule bool | NÃO | Flag para identificar se o atendimento está em agendamento ou não; |
| is_critical bool | NÃO | Flag para identificar se o atendimento está classificado como crítico ou não; |
| score int | SIM | Nota da pesquisa de satisfação enviado após a finalização do atendimento; |
| rating_survey_id int | SIM | ID interno da pesquisa de satisfação enviada para o cliente após a finalização do atendimento; |
| started_at datetime | SIM | Data/hora que o atendimento foi encaminhado para a fila de espera; |
| is_simulation bool | NÃO | APENAS PARA USO INTERNO |
| simulation_bot_id int | SIM | APENAS PARA USO INTERNO |
| latitude string | SIM | Latitude da instalação do serviço contratado pelo cliente; OBS: Esta informação está disponível apenas para contas que possuem integrações com ERP's que disponibilizam a localização do cliente; |
| longitude string | SIM | Longitude da instalação do serviço contratado pelo cliente; OBS: Esta informação está disponível apenas para contas que possuem integrações com ERP's que disponibilizam a localização do cliente; |
| initial_sender_channel int | NÃO | ID interno do canal que iniciou o atendimento; |
| is_waiting bool | NÃO | Flag para identificar se o atendimento está em espera ou não; |
| was_expired bool | NÃO | Flag para identificar se o atendimento foi encerrado por tempo de espera expirado ou não; |
| delivered_at datetime | SIM | Data/hora que o atendimento foi distribuído para um agente humano; |
| last_waiting_message_at datetime | SIM | Data/hora da última mensagem de espera enviada para o cliente; |
| is_shopping bool | NÃO | Flag para identificar se o atendimento foi iniciado pelo HubStore ou não; |
| is_ads bool | NÃO | Flag para identificar se o atendimento possui alguma mensagem recebidas através de um link de anúncio da Meta; |
| last_webchat_request_at datetime | SIM | APENAS PARA USO INTERNO |
| scaled_to int | SIM | Identificador interno do agente para o qual o atendimento foi escalonado; |
| client_ip string | SIM | IP do cliente; OBS: Esta informação está disponível apenas para atendimento através do canal Webchat; |
| client_user_agent string | SIM | User agent do browser do cliente; OBS: Esta informação está disponível apenas para atendimento através do canal Webchat; |
| survey_id int | SIM | Identificador interno de pesquisa que gerou o atendimento; |
| talk_category_id int | SIM | Identificador interno da categoria do atendimento; |
| talk_service_id int | SIM | Identificador interno do catálogo de serviço do atendimento; |
| initiation_type enum {c, m, n, r} | NÃO | Flag para identificar a origem da abertura do atendimento: * c (comment): Comentário em um story da empresa no Instagram ou Facebook; * m (mention): Menção em um story do cliente do Instagram ou Facebook; * n (normal): Normal; * r (reaction): Reação em um story da empresa no Instagram ou Facebook; |
| delivered_to int | SIM | Identificador interno do agente para o qual o atendimento foi distribuído; |
| external_protocol string | SIM | Número do protocolo externo do atendimento; OBS: Esta informação está disponível apenas para as contas que fazem atualização desse campo através da API; |
| tracking_number string | NÃO | Número do protocolo do atendimento; |
| url_viewer string | NÃO | URL do visualizador de atendimento que pode ser incorporado em outro sistema utilizando um iframe. OBS: Para o funcionamento do visualizador de atendimento, o host do site de origem precisa ser informado para a PipeRun para que possa ser adicionado à lista de permissões da conta; |
| talk_histories list <Object talkHistory> | SIM | Histórico de mensagens do atendimento; |
| customer <Object customer> | NÃO | Dados do cliente; |
| talk_events list <Object talkEvent> | SIM | Lista de tabulações do atendimento; |
| bot_variables list <Object botVariable> | SIM | Lista das variáveis capturadas pelo Bot que efetuou o pré-atendimento; |
| bot <Object Bot> | SIM | Dados do Bot que efetuou o pré-atendimento; |
Exemplo de payload - JSON
{
"id": 114603,
"customer_id": 144527,
"agent_id": 2,
"queue_id": 17,
"channel_id": 1,
"priority_id": 2,
"finished_at": "2025-09-08 11:01:19",
"was_success": false,
"created_at": "2025-09-08T14:01:17.000000Z",
"has_schedule": false,
"is_critical": false,
"score": null,
"rating_survey_id": null,
"started_at": null,
"is_simulation": false,
"simulation_bot_id": null,
"latitude": null,
"longitude": null,
"initial_sender_channel": "1",
"is_waiting": false,
"was_expired": false,
"delivered_at": null,
"last_waiting_message_at": null,
"is_shopping": false,
"is_ads": false,
"last_webchat_request_at": null,
"scaled_to": null,
"client_ip": null,
"client_user_agent": null,
"survey_id": null,
"talk_category_id": null,
"talk_service_id": null,
"initiation_type": "n",
"delivered_to": null,
"external_protocol": null,
"tracking_number": "20250908114603",
"url_viewer": "https://crmpiperun.cxm.pipe.run/viewer/cFl5YXAyYnVnRkNjM2Y1L0d0QTczdz09",
"talk_histories": [
{
"id": 2077775,
"talk_id": 114603,
"user_id": 2,
"queue_id": null,
"channel_id": 1,
"message": "Teste Jonas",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11:01:17",
"delivered_at": null,
"read_at": null,
"created_at": "2025-09-08T14:01:17.000000Z",
"was_read": false,
"has_highlight": false,
"from": "51999998888",
"type": "in",
"to": "1",
"external_id": "wamid.HBgMNTU1MTk1OTg4OTg4FQIAEhggNEI5RDhFRDQ2MEFFMkE2MUJDQ0JCREI4OUQ3NDNDN0MA",
"left_at": null,
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": "",
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 0,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
},
{
"id": 2077776,
"talk_id": 114603,
"user_id": 2,
"queue_id": 17,
"channel_id": 1,
"message": "Fila inicial definida como [PipeRun -> Ambos -> Atendimento BOT] pela configuração do Bot.",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11:01:17",
"delivered_at": null,
"read_at": null,
"created_at": "2025-09-08T14:01:17.000000Z",
"was_read": false,
"has_highlight": false,
"from": null,
"type": "system",
"to": null,
"external_id": null,
"left_at": null,
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": null,
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 0,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "6",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "3",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "5",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "11",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "4",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "8",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
},
{
"id": 2077777,
"talk_id": 114603,
"user_id": 2,
"queue_id": 17,
"channel_id": 1,
"message": "📣 Atenção! Nosso número de atendimento mudou. Agora você pode nos contatar pelo WhatsApp no link: 📲 https://bitly.run/WhatsPipeRun",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11: 01: 18",
"delivered_at": null,
"read_at": "2025-09-08 11: 01: 20",
"created_at": "2025-09-08T14: 01: 18.000000Z",
"was_read": true,
"has_highlight": false,
"from": null,
"type": "out",
"to": "555195988988",
"external_id": "wamid.HBgMNTU1MTk1OTg4OTg4FQIAERgSQThDMUUxOTg0RUEzODg2QTY1AA==",
"left_at": "2025-09-08 11: 01: 18",
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": null,
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 3,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13: 40: 14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "6",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "3",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "5",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "11",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "4",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "8",
"filename": "Default.mp3"
}
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
}
],
"customer": {
"id": 144527,
"name": "JONAS",
"external_id": "95238935",
"document_number": "",
"wildcard_01": "",
"wildcard_02": "",
"wildcard_03": "",
"wildcard_04": "",
"wildcard_05": "",
"wildcard_06": "",
"wildcard_07": "",
"wildcard_08": "",
"wildcard_09": "",
"wildcard_10": "",
"created_at": "2023-09-21T12: 28: 45.000000Z",
"main_sms": 44290,
"main_whatsapp": 44290,
"main_email": 25396,
"agent_id": null,
"queue_id": null,
"customer_group_id": null,
"profile_picture_url": null,
"is_priority": false,
"last_base_api": null,
"customer_organization_id": 15662,
"crmv_user_id": 65886,
"crmv_person_id": 9523893,
"is_active": true,
"cxm_user_id": null,
"profile_info": {
"name": "Jonas Schen",
"username": "j.schen",
"profile_pic": "https: //scontent-gru1-2.cdninstagram.com/v/t51.2885-19/136402463_253976186149719_5865312005602673050_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=1-7&_nc_sid=bf7eb4&_nc_eui2=AeHYN5VZiIc-sNtHGCgs4254feyGsovGEtd97Iayi8YS108vxDsrXCu3TL9YLx0Gt0ajlYNuFFeStw7XimoOCt8c&_nc_ohc=ZvuS5PnxbuIQ7kNvwEFvYu8&_nc_oc=Adkmlu7T1RN2lcleakngSeC_fbAhYLw5m6KANJ33KMsM1KnrjaOstylyzRgEtOt1fcc&_nc_zt=24&_nc_ht=scontent-gru1-2.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AfSiRcadzk9IDd3dKCgN1WnE9_6TvlAdGfsDeZrsdNBMrw&oe=687F1E0E",
"is_verified_user": false,
"follower_count": 219,
"is_user_follow_business": true,
"is_business_follow_user": false,
"id": "8215422678527800"
},
"custom_fields": {
"Empresa": "Piperun",
"Web Whatsapp - Pessoa": "(51) 99999-8888",
"Nacionalidade": "Brasileira"
},
"telephones": [
{
"id": 70994,
"customer_id": 144527,
"area_code": "51",
"number": "999887766",
"type": "m",
"level_id": "N",
"has_sms": false,
"has_whatsapp": false,
"has_whatsapp_api": false,
"wa_is_business": false,
"wa_is_enterprise": false,
"wa_contact_name": null,
"wa_pushname": null,
"wa_verified_level": null,
"wa_verified_name": null,
"wa_profile_picture": null,
"session_expires_at": null,
"insert_origin": "MAILING",
"inserted_by": 127,
"country_code": "55",
"country_iso2": "br",
"full_number": "51999887766",
"full_number_cc": "+55 51999887766"
}
],
"emails": [
{
"id": 49543,
"customer_id": 144527,
"email": "[email protected]",
"level_id": "N",
"insert_origin": "AUTO",
"inserted_by": 2,
"unsubscribed_at": null
}
]
},
"talk_events": [
{
"id": 80991,
"talk_id": 114603,
"event_id": 87,
"queue_id": 17,
"is_success": false,
"created_at": "2025-09-08T14:01:19.000000Z",
"agent_id": 2,
"channel_id": 1,
"reaction_type": "f",
"reaction_type_description": "Finalizar",
"event": {
"id": 87,
"description": "Finalizado pelo BOT",
"external_id": 12
}
}
],
"bot_variables": [
{
"var_name": "@botCustomerContext_id",
"value": "40109"
},
{
"var_name": "@bot_score",
"value": "90"
}
],
"bot": {
"id": 105,
"description": "Informativo - TROCA DE CANAL - 2025"
}
}OBJETO MENSAGEM DO ATENDIMENTO [TALKHISTORY]
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do cliente; |
| talk_id int | NÃO | Identificador interno do atendimento; |
| user_id int | NÃO | Identificador interno do usuário que enviou a mensagem; |
| queue_id int | SIM | Identificador interno da fila onde o atendimento estava no momento do envio/recebimento da mensagem; |
| channel_id int | NÃO | Identificador interno do canal pelo qual a mensagem foi enviada/recebida; |
| message string | SIM | Corpo da mensagem; |
| has_attachment bool | NÃO | Flag para identificar se a mensagem possui anexo ou não; |
| attachment_url string | SIM | URL do anexo; |
| attachment_type_id enum {AUDIO, FILE, IMAGE, VIDEO, LOCATION, CONTACT, MENU, CATALOG, CATALOG_REPLY, CATALOG_ORDER, ADS, WEBCHAT_NOTIFICATION, PROPOSAL_ORDER, PIX_CODE, INVOICE} | SIM | Flag para identificar o tipo de anexo: * 1: Áudio; * 2: Arquivo; * 3: Imagem; * 4: Vídeo; * 5: Localização; * 6: Contato; * 7: Menu; * 8: Catálogo; * 9: Resposta de catálogo; * 10: Pedido de catálogo; * 11: Anúncio; * 12: Notificação do Webchat * 13: Pedido de proposta; * 14: Código PIX; * 15: Fatura; |
| sent_at datetime | NÃO | Data/hora do envio da mensagem; |
| delivered_at datetime | SIM | Data/hora que a mensagem foi entregue para o cliente; |
| read_at datetime | SIM | Data/hora que a mensagem foi lida pelo cliente ou agente; |
| created_at datetime | NÃO | Data/hora que a mensagem foi criada; |
| was_read bool | NÃO | Flag para identificar se a mensagem foi lida ou não; |
| has_highlight bool | NÃO | Flag para identificar se a mensagem possui uma palavra em destaque ou não; |
| from string | NÃO | Remente da mensagem; |
| type enum {IN, OUT, SYSTEM} | NÃO | Flag para identificar o tipo da mensagem: * IN: Mensagem recebida; * OUT: Mensagem enviada; * SYSTEM: Mensagem de sistema; |
| to string | NÃO | Destinatário da mensagem; |
| external_id string | SIM | Identificador externo da mensagem na Meta ou broker; |
| left_at datetime | SIM | Data/hora que a mensagem saiu da fila de envio do sistema; |
| has_error bool | NÃO | Flag para identificar se houve erro no envio da mensagem ou não; |
| campaign_id int | SIM | Identificador interno da campanha responsável pelo envio da mensagem; |
| was_blocked bool | NÃO | Flag para identificar se o envio da mensagem foi bloqueado ou não; |
| is_template bool | NÃO | Flag para identificar se a mensagem é um template; |
| response_from int | SIM | Identificador interno da mensagem que foi respondida; |
| fare float | SIM | CAMPO DEPRECIADO |
| error_reason string | SIM | Descrição do motivo do erro ou bloqueio no envio da mensagem; |
| template_id int | SIM | Identificador interno do template utilizado no envio da mensagem; |
| original_message string | SIM | Corpo da mensagem, sem tratamento de variáveis; |
| subject string | SIM | Assunto do e-mail; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal E-mail; |
| exceeded_allowance bool | NÃO | CAMPO DEPRECIADO |
| is_intervention bool | NÃO | Flag para identificar se a mensagem foi enviada através de intervenção do supervisor ou não; |
| is_forwarded bool | NÃO | Flag para identificar se a mensagem recebida foi encaminhada pelo cliente ou não; |
| is_frequently_forwarded bool | NÃO | Flag para identificar se a mensagem recebida está sendo encaminhada com frequência por vários usuários do WhatsApp; |
| is_ads bool | NÃO | Flag para identificar se a mensagem foi enviada pelo cliente através de um link de anúncio da Meta; |
| is_reverted_template bool | NÃO | Flag para identificar se a mensagem era um HSM e foi revertido em mensagem comum pelo sistema; |
| reaction string | SIM | Emoji enviado como reação da mensagem; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal WhatsApp; |
| customer_reaction string | SIM | Emoji recebido como reação da mensagem; OBS: Esta informação está disponível apenas mensagens enviadas pelo canal WhatsApp; |
| status enum {0, 1, 2, 3, 4, 5} | NÃO | Flag para identificar o status do envio da mensagem: * 0: Não enviada; * 1: Enviada; * 2: Entregue; * 3: Lida; * 4: Bloqueada; * 5: Erro no envio; |
| is_hidden bool | NÃO | Flag para identificar se o agente atual tem permissão para visualizar o conteúdo da mensagem; |
| file_name string | SIM | Nome do arquivo em anexo; |
| attachment_type <Object attachmentType> | SIM | Dados do tipo de anexo; |
| user <Object user> | NÃO | Dados do usuário |
| channel <Object channel> | NÃO | Dados do canal |
Exemplo de payload - JSON
{
"id": 2077775,
"talk_id": 114603,
"user_id": 2,
"queue_id": null,
"channel_id": 1,
"message": "Teste Jonas",
"has_attachment": false,
"attachment_url": null,
"attachment_type_id": null,
"sent_at": "2025-09-08 11:01:17",
"delivered_at": null,
"read_at": null,
"created_at": "2025-09-08T14:01:17.000000Z",
"was_read": false,
"has_highlight": false,
"from": "51999998888",
"type": "in",
"to": "1",
"external_id": "wamid.HBgMNTU1MTk1OTg4OTg4FQIAEhggNEI5RDhFRDQ2MEFFMkE2MUJDQ0JCREI4OUQ3NDNDN0MA",
"left_at": null,
"has_error": false,
"campaign_id": null,
"was_blocked": false,
"is_template": false,
"response_from": null,
"fare": "0",
"error_reason": null,
"template_id": null,
"original_message": null,
"subject": "",
"exceeded_allowance": false,
"is_intervention": false,
"is_forwarded": false,
"is_frequently_forwarded": false,
"is_ads": false,
"send_after": null,
"is_reverted_template": false,
"reaction": null,
"customer_reaction": null,
"status": 0,
"is_hidden": false,
"file_name": "",
"attachment_type": [],
"user": {
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
]
},
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
},
"channel": {
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}
}OBJETO TIPO DE ANEXO [ATTACHNENTTYPE]
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do tipo de anexo; |
| description string | NÃO | Descrição do tipo de anexo; |
Exemplo de payload - JSON
{
"id": "1",
"description": "Áudio"
}OBJETO USUÁRIO [USER]
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do usuário; |
| branch_id int | NÃO | Identificador interno da filial a qual usuário pertence; |
| name string | NÃO | Nome do usuário; |
| login string | SIM | CAMPO DEPRECIADO |
| email string | NÃO | Endereço de e-mail do usuário; |
| level_id int | NÃO | Identificador interno do nível de acesso do usuário; |
| language_id int | NÃO | Identificador interno do idioma do usuário; |
| can_external_access bool | NÃO | Flag para identificar se o usuário pode acessar o sistema externamente ou não; |
| email_verified_at datetime | SIM | Data/hora que o e-mail foi verificado; |
| created_at datetime | NÃO | Data/hora que o usuário foi criado; |
| is_active bool | NÃO | Flag para identificar se o usuário está ativo ou não; |
| is_bot bool | NÃO | Flag para identificar se o usuário é um bot ou não; |
| whatsapp_number string | SIM | Número do WhatsApp do usuário; |
| can_api_access bool | NÃO | Flag para identificar se o usuário pode acessar a API ou não; |
| preferences Object userPreferences | NÃO | PARA USO INTERNO |
| can_export_report bool | NÃO | Flag para identificar se o usuário pode exportar relatórios ou não; |
| user_id int | NÃO | Identificador interno do usuário que criou este usuário; |
| force_change_password bool | NÃO | Flag para identificar se o usuário será obrigado a alterar a senha no próximo acesso; |
| support_external_id string | SIM | PARA USO INTERNO |
| last_login_mode string | SIM | PARA USO INTERNO |
| show_bot_academy_advice bool | NÃO | PARA USO INTERNO |
| last_login_method string | SIM | PARA USO INTERNO |
Exemplo de payload - JSON
{
"id": 2,
"branch_id": 1,
"name": "PipeBot",
"login": "bot",
"email": "",
"level_id": 4,
"language_id": 1,
"can_external_access": false,
"email_verified_at": "2023-08-09T13:40:14.000000Z",
"created_at": null,
"is_active": true,
"is_bot": true,
"whatsapp_number": null,
"can_api_access": false,
"preferences": {
"notification_channels": "all",
"notification_options": "same",
"notification_sound_default": {
"id": "1",
"description": "Default",
"filename": "Default.mp3"
},
"map_mode": "satellite",
"map_service": "google_maps",
"enter_key_settings": "new_line",
"activate_shortcuts": "off",
"customized_notifications": [
{
"id": "1",
"description": "Default",
"channel_id": "2",
"filename": "Default.mp3"
},
{
"id": "1",
"description": "Default",
"channel_id": "1",
"filename": "Default.mp3"
},
]
}
"can_export_report": true,
"user_id": 1,
"force_change_password": false,
"support_external_id": null,
"last_login_mode": null,
"show_bot_academy_advice": true,
"last_login_method": "local"
}OBJETO CANAL [CHANNEL]
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do canal; |
| description string | NÃO | Descrição do canal; |
| icon_class string | NÃO | PARA USO INTERNO |
| priority int | SIM | CAMPO DEPRECIADO |
| primary_color string | NÃO | PARA USO INTERNO |
| secondary_color string | NÃO | PARA USO INTERNO |
| is_active bool | NÃO | Flag para identificar se o canal está ativo na conta ou não; |
| incoming_type string | SIM | CAMPO DEPRECIADO |
| enable_emoji bool | NÃO | PARA USO INTERNO |
| enable_attachment bool | NÃO | PARA USO INTERNO |
| allow_campaign bool | NÃO | PARA USO INTERNO |
| provider_id int | SIM | Identificador interno do fornecedor do canal; |
| unitary_price float | SIM | CAMPO DEPRECIADO |
| template_price float | SIM | CAMPO DEPRECIADO |
| outgoing_type string | SIM | CAMPO DEPRECIADO |
| allow_bot bool | NÃO | PARA USO INTERNO |
| additional_price float | SIM | CAMPO DEPRECIADO |
| messages_allowance float | SIM | CAMPO DEPRECIADO |
Exemplo de payload - JSON
{
"id": 1,
"description": "WhatsApp",
"icon_class": "fab fa-whatsapp",
"priority": 1,
"primary_color": "#4caf50",
"secondary_color": "#9dd5a8",
"is_active": true,
"incoming_type": "w",
"enable_emoji": true,
"enable_audio": true,
"enable_attachment": true,
"allow_campaign": true,
"provider_id": 7,
"unitary_price": "0",
"template_price": "0",
"outgoing_type": "s",
"allow_bot": true,
"additional_price": "0",
"messages_allowance": 0
}OBJETO CLIENTE [CUSTOMER]
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do cliente; |
| name string | NÃO | Nome do cliente; |
| external_id string | SIM | Identificador externo do cliente; |
| document_number string | SIM | Número do documento do cliente; |
| wildcard_01 string | SIM | CAMPO DEPRECIADO |
| wildcard_02 string | SIM | CAMPO DEPRECIADO |
| wildcard_03 string | SIM | CAMPO DEPRECIADO |
| wildcard_04 string | SIM | CAMPO DEPRECIADO |
| wildcard_05 string | SIM | CAMPO DEPRECIADO |
| wildcard_06 string | SIM | CAMPO DEPRECIADO |
| wildcard_07 string | SIM | CAMPO DEPRECIADO |
| wildcard_08 string | SIM | CAMPO DEPRECIADO |
| wildcard_09 string | SIM | CAMPO DEPRECIADO |
| wildcard_10 string | SIM | CAMPO DEPRECIADO |
| created_at datetime | NÃO | Data/hora da criação do cliente; |
| main_sms int | SIM | Identificador interno do número de SMS prioritário; |
| main_whatsapp int | SIM | Identificador interno do número de WhatsApp prioritário; |
| main_email int | SIM | Identificador interno do endereço de e-mail prioritário; |
| agent_id int | SIM | Identificador interno do agente ao qual o cliente está fidelizado; |
| queue_id int | SIM | Identificador interno da fila de atendimento à qual o cliente está fidelizado; |
| profile_picture_url string | SIM | CAMPO DEPRECIADO |
| is_priority bool | NÃO | Flag para identificar se o cliente é prioritário ou não; |
| last_base_api string | SIM | Identificador da base da integração do cliente no último atendimento iniciado; OBS: Esta informação está disponível apenas para contas que possuem integração com ERP's com a funcionalidade de multi-bases; |
| customer_organization_id int | SIM | Identificador interno da organização à qual o cliente pertence; |
| crmv_user_id int | SIM | CAMPO DEPRECIADO |
| crmv_person_id int | SIM | CAMPO DEPRECIADO |
| is_active bool | NÃO | CAMPO DEPRECIADO |
| cxm_user_id int | SIM | CAMPO DEPRECIADO |
| profile_info <Object profileInfo> | SIM | Dados do perfil do cliente; |
| custom_fields list <Object customerCustomField> | SIM | Lista de campos customizados; |
| telephones list <Object customerTelephone> | SIM | Lista de telefones do cliente; |
| emails list <Object customerEmail> | SIM | Lista de e-mails do cliente; |
Exemplo de payload - JSON
{
"id": 144527,
"name": "JONAS",
"external_id": "95238935",
"document_number": "",
"wildcard_01": "",
"wildcard_02": "",
"wildcard_03": "",
"wildcard_04": "",
"wildcard_05": "",
"wildcard_06": "",
"wildcard_07": "",
"wildcard_08": "",
"wildcard_09": "",
"wildcard_10": "",
"created_at": "2023-09-21T12: 28: 45.000000Z",
"main_sms": 44290,
"main_whatsapp": 44290,
"main_email": 25396,
"agent_id": null,
"queue_id": null,
"customer_group_id": null,
"profile_picture_url": null,
"is_priority": false,
"last_base_api": null,
"customer_organization_id": 15662,
"crmv_user_id": 65886,
"crmv_person_id": 9523893,
"is_active": true,
"cxm_user_id": null,
"profile_info": {
"name": "Jonas Schen",
"username": "j.schen",
"profile_pic": "https: //scontent-gru1-2.cdninstagram.com/v/t51.2885-19/136402463_253976186149719_5865312005602673050_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=1-7&_nc_sid=bf7eb4&_nc_eui2=AeHYN5VZiIc-sNtHGCgs4254feyGsovGEtd97Iayi8YS108vxDsrXCu3TL9YLx0Gt0ajlYNuFFeStw7XimoOCt8c&_nc_ohc=ZvuS5PnxbuIQ7kNvwEFvYu8&_nc_oc=Adkmlu7T1RN2lcleakngSeC_fbAhYLw5m6KANJ33KMsM1KnrjaOstylyzRgEtOt1fcc&_nc_zt=24&_nc_ht=scontent-gru1-2.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AfSiRcadzk9IDd3dKCgN1WnE9_6TvlAdGfsDeZrsdNBMrw&oe=687F1E0E",
"is_verified_user": false,
"follower_count": 219,
"is_user_follow_business": true,
"is_business_follow_user": false,
"id": "8215422678527800"
},
"custom_fields": {
"Empresa": "Piperun",
"Web Whatsapp - Pessoa": "(51) 99999-8888",
"Nacionalidade": "Brasileira"
},
"telephones": [
{
"id": 70994,
"customer_id": 144527,
"area_code": "51",
"number": "999887766",
"type": "m",
"level_id": "N",
"has_sms": false,
"has_whatsapp": false,
"has_whatsapp_api": false,
"wa_is_business": false,
"wa_is_enterprise": false,
"wa_contact_name": null,
"wa_pushname": null,
"wa_verified_level": null,
"wa_verified_name": null,
"wa_profile_picture": null,
"session_expires_at": null,
"insert_origin": "MAILING",
"inserted_by": 127,
"country_code": "55",
"country_iso2": "br",
"full_number": "51999887766",
"full_number_cc": "+55 51999887766"
}
],
"emails": [
{
"id": 49543,
"customer_id": 144527,
"email": "[email protected]",
"level_id": "N",
"insert_origin": "AUTO",
"inserted_by": 2,
"unsubscribed_at": null
}
]
}OBJETO INFORMAÇÕES DE PERFIL DO CLIENTE [PROFILEINFO]
| Campos | Nullable | Descrição |
|---|---|---|
| name string | NÃO | Nome do cliente no Instagram ou Facebook; |
| username string | SIM | Nome de usuário do cliente no Instagram ou Facebook; OBS: Esta informação está disponível apenas para contas que possuem os canais Instagram ou Messenger ativos e o cliente já entrou em contato através de um destes canais; |
| profile_pic string | SIM | Foto do perfil do cliente no Instagram ou Facebook; OBS: Esta informação está disponível apenas para contas que possuem os canais Instagram ou Messenger ativos e o cliente já entrou em contato através de um destes canais; |
| is_verified_user bool | SIM | Flag para identificar se o perfil do cliente, no Instagram ou Facebook, é verificado; OBS: Esta informação está disponível apenas para contas que possuem os canais Instagram ou Messenger ativos e o cliente já entrou em contato através de um destes canais; |
| follower_count int | SIM | Quantidade de seguidores que o cliente possui no Instagram; OBS: Esta informação está disponível apenas para contas que possuem o canal Instagram ativo e o cliente já entrou em contato através deste canal; |
| is_user_follow_business bool | SIM | Flag para identificar se o cliente segue o perfil da empresa no Instagram; OBS: Esta informação está disponível apenas para contas que possuem o canal Instagram ativo e o cliente já entrou em contato através deste canal; |
| is_business_follow_user bool | SIM | Flag para identificar se a empresa segue o perfil do cliente no Instagram; OBS: Esta informação está disponível apenas para contas que possuem o canal Instagram ativo e o cliente já entrou em contato através deste canal; |
| id int | NÃO | Identificador do perfil do cliente no Instagram ou Facebook; OBS: Esta informação está disponível apenas para contas que possuem os canais Instagram ou Messenger ativos e o cliente já entrou em contato através de um destes canais; |
Exemplo de payload - JSON
{
"name": "Jonas Schen",
"username": "j.schen",
"profile_pic": "https: //scontent-gru1-2.cdninstagram.com/v/t51.2885-19/136402463_253976186149719_5865312005602673050_n.jpg?stp=dst-jpg_s206x206_tt6&_nc_cat=100&ccb=1-7&_nc_sid=bf7eb4&_nc_eui2=AeHYN5VZiIc-sNtHGCgs4254feyGsovGEtd97Iayi8YS108vxDsrXCu3TL9YLx0Gt0ajlYNuFFeStw7XimoOCt8c&_nc_ohc=ZvuS5PnxbuIQ7kNvwEFvYu8&_nc_oc=Adkmlu7T1RN2lcleakngSeC_fbAhYLw5m6KANJ33KMsM1KnrjaOstylyzRgEtOt1fcc&_nc_zt=24&_nc_ht=scontent-gru1-2.cdninstagram.com&edm=ALmAK4EEAAAA&oh=00_AfSiRcadzk9IDd3dKCgN1WnE9_6TvlAdGfsDeZrsdNBMrw&oe=687F1E0E",
"is_verified_user": false,
"follower_count": 219,
"is_user_follow_business": true,
"is_business_follow_user": false,
"id": "8215422678527800"
}OBJETO CAMPO CUSTOMIZADO DO CLIENTE [CUSTOMERCUSTONFIELD]
Os campos deste objeto são dinâmicos e seguem o formato chave -> valor.
A chave será o nome do campo customizado e o valor será o conteúdo do campo customizado e o tipo de dado será sempre string.
Exemplo de payload - JSON
{
"Empresa": "Piperun",
"Web Whatsapp - Pessoa": "(51) 99999-8888",
"Nacionalidade": "Brasileira"
}OBJETO TELEFONE DO CLIENTE [CUSTOMERTELEPHONE]
| Campos | Nullable | Descrição |
|---|---|---|
| id string | NÃO | Identificador interno do telefone; |
| customer_id int | NÃO | Identificador interno do cliente ao qual o telefone pertence; |
| area_code string | NÃO | DDD do telefone; |
| number string | NÃO | Número do telefone |
| type enum {m, f} | NÃO | Flag para identificar o tipo do telefone: * m: Móvel; * f: Fixo; |
| level_id string | NÃO | Identificador da classificação do telefone; |
| has_sms bool | NÃO | Flag para identificar se o telefone está disponível para recebimento de mensagens via SMS; |
| has_whatsapp bool | NÃO | Flag para identificar se o telefone está disponível para recebimento de mensagens via WhatsApp; |
| has_whatsapp_api bool | NÃO | CAMPO DEPRECIADO |
| wa_is_business bool | NÃO | CAMPO DEPRECIADO |
| wa_is_enterprise bool | NÃO | CAMPO DEPRECIADO |
| wa_contact_name string | SIM | CAMPO DEPRECIADO |
| wa_pushname string | SIM | CAMPO DEPRECIADO |
| wa_verified_level string | SIM | CAMPO DEPRECIADO |
| wa_verified_name string | SIM | CAMPO DEPRECIADO |
| wa_profile_picture string | SIM | CAMPO DEPRECIADO |
| session_expires_at datetime | SIM | CAMPO DEPRECIADO |
| insert_origin enum {AUTO, HUBSTORE, MAILING, MANUAL} | NÃO | Flag para identificar a origem da inclusão do telefone: * AUTO: Inclusão automática através de um novo atendimento receptivo; * HUBSTORE: Incluído através de um atendimento oriundo do HubStore; * MAILING: Incluído através de uma importação de arquivo de mailing; * MANUAL: Incluído manualmente por um usuário através de interface do sistema; |
| inserted_by int | NÃO | Identificador interno do usuário responsável pela inclusão do telefone; |
| country_code string | NÃO | DDI do telefone; |
| country_iso2 string | NÃO | Código ISO2 do país correspondente ao DDI; |
| full_number string | NÃO | Número completo do telefone (DDD+Número); |
| full_number_cc string | NÃO | Número completo do telefone com o DDI (DDI+DDD+Número); |
Exemplo de payload - JSON
{
"id": 70994,
"customer_id": 144527,
"area_code": "51",
"number": "999887766",
"type": "m",
"level_id": "N",
"has_sms": false,
"has_whatsapp": false,
"has_whatsapp_api": false,
"wa_is_business": false,
"wa_is_enterprise": false,
"wa_contact_name": null,
"wa_pushname": null,
"wa_verified_level": null,
"wa_verified_name": null,
"wa_profile_picture": null,
"session_expires_at": null,
"insert_origin": "MAILING",
"inserted_by": 127,
"country_code": "55",
"country_iso2": "br",
"full_number": "51999887766",
"full_number_cc": "+55 51999887766"
}OBJETO E-MAIL DO CLIENTE [CUSTOMEREMAIL]
| Campos | Nullable | Descrição |
|---|---|---|
| id string | NÃO | Identificador interno do e-mail; |
| customer_id int | NÃO | Identificador interno do cliente ao qual o e-mail pertence; |
| email string | NÃO | Endereço do e-mail; |
| level_id string | NÃO | Identificador da classificação do e-mail; |
| insert_origin enum {AUTO, HUBSTORE, MAILING, MANUAL} | NÃO | Flag para identificar a origem da inclusão do telefone: * AUTO: Inclusão automática através de um novo atendimento receptivo; * HUBSTORE: Incluído através de um atendimento oriundo do HubStore; * MAILING: Incluído através de uma importação de arquivo de mailing; * MANUAL: Incluído manualmente por um usuário através de interface do sistema; |
| inserted_by int | NÃO | Identificador interno do usuário responsável pela inclusão do e-mail; |
Exemplo de payload - JSON
{
"id": 49543,
"customer_id": 144527,
"email": "[email protected]",
"level_id": "N",
"insert_origin": "AUTO",
"inserted_by": 2,
"unsubscribed_at": null
}OBJETO TABULAÇÃO DO ATENDIMENTO[TALKEVENT]
| Campos | Nullable | Descrição |
|---|---|---|
| id string | NÃO | Identificador interno do registro da inclusão da tabulação; |
| talk_id int | NÃO | Identificador interno do atendimento; |
| event_id int | NÃO | Identificador interno da tabulação inserida; |
| queue_id int | NÃO | Identificador interno da fila de atendimento onde o atendimento estava no momento da inclusão da tabulação; |
| is_success bool | NÃO | Flag para identificar se a tabulação era positiva ou não, no momento da inclusão; |
| created_at datetime | NÃO | Data/hora que a tabulação foi inserida; |
| agent_id int | NÃO | D interno do agente que efetuou a inclusão da tabulação; |
| channel_id int | NÃO | Identificador interno do canal de atendimento onde o atendimento estava no momento da inclusão da tabulação; |
| reaction_type enum {f, n, w} | NÃO | Flag para identificar o tipo de reação da tabulação inserida; * f (Finish): Finalizar; * n (Nome): Nenhuma; * w (Wait): Colocar em espera; |
| reaction_type_description string | NÃO | Descrição do tipo de reação da tabulação inserida; |
| event <Object event> | NÃO | Dados da tabulação inserida; |
Exemplo de payload - JSON
{
"id": 80991,
"talk_id": 114603,
"event_id": 87,
"queue_id": 17,
"is_success": false,
"created_at": "2025-09-08T14:01:19.000000Z",
"agent_id": 2,
"channel_id": 1,
"reaction_type": "f",
"reaction_type_description": "Finalizar",
"event": {
"id": 87,
"description": "Finalizado pelo BOT",
"external_id": 12
}
}OBJETO EVENTO DE TABULAÇÃO[EVENT]
| Campos | Nullable | Descrição |
|---|---|---|
| id string | NÃO | ID interno da tabulação; |
| description string | NÃO | Descrição da tabulação; |
| external_id string | SIM | ID externo da tabulação; |
Exemplo de payload - JSON
{
"id": 87,
"description": "Finalizado pelo BOT",
"external_id": 12
}OBJETO VARIÁVEL DO BOT [BOTVARIABLE]
Todas as variáveis armazenadas pelo Bot podem ser enviadas, inclusive as coletadas a partir de integrações com outros sistema através de ações do Bot.
| Campos | Nullable | Descrição |
|---|---|---|
| var_name string | NÃO | Nome da variável; |
| value string | NÃO | Valor da variável; |
Exemplo de payload - JSON
{
"var_name": "@bot_score",
"value": "90"
}OBJETO BOT [BOT]
Retorna informações a respeito do Bot que realizou o atendimento.
| Campos | Nullable | Descrição |
|---|---|---|
| id int | NÃO | Identificador interno do Bot; |
| description string | NÃO | Nome do Bot; |
Exemplo de payload - JSON
{
"id": 105,
"description": "Informativo - TROCA DE CANAL - 2025"
}COMO CONFIGURAR A INTEGRAÇÃO VIA WEBHOOK
No CXM de atendimento PipeRun, é possível configurar webhook diferentes para cada filial cadastrada podendo-se assim enviar dados para diferentes sistemas conforme o cadastro de cada filial.
1. No painel administrativo, clique em "Configurações" (1). Após, clique na opção "Parâmetros" (2) para abrir a tela que apresenta uma listagem com as filiais com seus parâmetros cadastrados.
2. Identifique a filial para qual deseja realizar a configuração e na coluna de ações clique no ícone de edição
3. Vá até a seção Configurações de webhooks.
Dica: você pode cadastrar vários endpoints para que as informações sejam enviadas simultaneamente a mais de um sistema. Para isso, insira todos os endereços no campo de configuração do webhook, separando cada um deles com ponto e vírgula (“;”).
4. No campo Headers, informe cada header em uma linha e separe os campos dos valores com o sinal (:).
Exemplo:<br>ContentType:application/json<br>
Authorization:Bearer abc123xyz
5. A seguir defina ative o gatilho do webhook. Um gatilho de webhook é o evento que ativa o envio automático de dados de um sistema para outro.
As opções são:
- Ativar webhook de atendimentos;
- Ativar webhook de conversas;
- Ativar webhook de tabulações;
- Ativar webhook de agendamentos.
Dica: Este artigo aborda apenas o webhook de atendimentos. Para outros gatilhos, é necessário contatar o time de suporte da PipeRun para receber mais detalhes sobre outros modelo de dados (payload).
6. No campo Endpoint informe a URL para onde os dados devem ser enviados.
7. Após finalizar as configurações, clique em "Salvar".
Pronto! A partir deste momento todos os atendimentos quando forem finalizados enviarão dado para outros sistemas.
Em caso de dúvidas , chame nossa equipe no chat . 😉