Lançamento da nova documentação da API v2 do RD Station Conversas.

Novidades

• Centralização da documentação no portal RD Station Developers
• Migração da especificação OpenAPI de 3.0.0 para 3.1.1
• Nova estrutura de documentação seguindo padrão RD Station
• Documentação contextualizada por recurso
• Exemplos de código atualizados

Recursos Documentados

• Contatos: Gerenciamento completo de contatos
• Mensagens: Envio e histórico de mensagens
• Templates: Gerenciamento e envio de templates
• Funcionários: Gerenciamento de operadores
• Carteiras: Consulta de carteiras de atendimento
• Workflows: Consulta de workflows de vendas
• Flows: Fluxos de automação
• Campos Personalizados: Gerenciamento de custom fields
• WhatsApp: Integrações WhatsApp
• Relatórios: Consulta de relatórios (v4)
• Jobs: Monitoramento de rotinas assíncronas

Links

Para mais informações, acesse a documentação da API v2 do RD Station Conversas.

Os eventos legados utilizados para representar ações em e-commerce entrarão em processo de descontinuação (sunset) e serão removidos da API em 31 de dezembro de 2025.

Eventos obsoletos:
• ORDER_PLACED
• ORDER_PLACED_ITEM
• CART_ABANDONED
• CART_ABANDONED_ITEM

A substituição pelos novos eventos de ecommerce oferece maior clareza e compatibilidade com recursos como automações e emails personalizados.

Recomendamos que todas as integrações migrem para os novos eventos até 31 de dezembro de 2025.

→ Acesse o guia de migração para instruções completas e mapeamento entre os eventos antigos e os novos.

A API agora suporta um novo conjunto de eventos padronizados para representar o comportamento de compra em e-commerce, oferecendo maior precisão e consistência para integrações e automações.

Eventos disponíveis:
• ECOMMERCE_ORDER_PLACED
• ECOMMERCE_ORDER_PAID
• ECOMMERCE_ORDER_FULFILLED
• ECOMMERCE_ORDER_REFUNDED
• ECOMMERCE_SHIPMENT_DELIVERED
• ECOMMERCE_CHECKOUT_STARTED
• ECOMMERCE_CART_ABANDONED
• ECOMMERCE_ORDER_CANCELLED

→ Consulte a documentação atualizada para detalhes sobre os novos formatos e orientações.

A propriedade amount_decimal foi incluída para permitir a representação precisa de valores monetários com casas decimais em produtos associados a negociações. Esta alteração está disponível nos seguintes end-points da API:

• GET /api/v1/deals/{deal_id}/deal_products
• GET /api/v1/deals/{deal_id}
• GET /api/v1/deals
• GET /api/v1/deals/{deal_id}

Essa atualização garante maior fidelidade na obtenção de valores, especialmente em cenários que envolvem centavos.

Foram adicionados novos webhooks para o RD Station CRM, dentre eles: contatos, empresas, produtos, tarefas, fontes, campanhas e motivos de perda. Para mais detalhes você pode consultar a página webhooks.

Liberamos o acesso para criação e atualização de webhooks para o plano Basic, assim como temos nos planos Pro e Advanced.

Foi criada a possibilidade de se criar campos personalizados para produtos e serviços. Agora esses campos podem ser associados aos produtos e serviços através dos end-points de criação e atualização de produtos e serviços.

Os end-points de listar produtos e obter produto, também passam a ter os campos personalizados associados aos produtos e serviços.

Adicionamos o parâmetro next_page no end-point GET /api/v1/deals que permite navegar por todas as negociações filtradas no end-point. Até este momento, existia uma limitação técnica que impedia a navegação numa lista de mais de 10 mil negociações.

Este parâmetro permitirá navegar por todas essas negociações como uma rolagem infinita (navegação página a página) por todas as negociações. Para tanto, faça uma primeira requisição e obtenha na resposta da requisição o valor do campo next_page, utilize este campo e seu valor como parâmetro da próxima requisição para obter a próxima página do resultado da busca. Refaça as requisições desta forma até quando achar necessário.

O status HTTP de sucesso do end-point DELETE /api/v1/deals/:deal_id/deal_products/batch/destroy foi alterado de 204, com resposta No content, para 200, com resposta indicando que a operação foi executada com sucesso e mostrando os produtos ainda associados, para refletir a resposta correta deste end-point.

Realizamos uma correção na página dos parâmetros dos webhooks. O parâmetro include_relations estava sendo listado como um parâmetro personalizável na criação e atualização dos webhooks. No entanto, esse não é um parâmetro que pode ser enviado em sua criação e atualização, portanto, foi removido para evitar confusão.