> For the complete documentation index, see [llms.txt](https://docs.yoplanning.support/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yoplanning.support/pt/faq-developpeur/faq-utilisation-des-webhooks-dans-yoplanning.md).

# FAQ: Usando Webhooks no YoPlanning

O YoPlanning oferece o uso de webhooks, uma ferramenta poderosa para sistemas de informação que requerem sincronização automática ou atualizações em tempo real.

### **O que é um Webhook?**

Um webhook é um método que permite que um aplicativo envie informações automaticamente para outros sistemas ou aplicativos em tempo real, assim que um evento ocorre. Ao contrário dos métodos tradicionais de recuperação de informações, que exigem consultas periódicas para verificar alterações, os webhooks fornecem esses dados imediatamente, permitindo uma resposta rápida aos eventos.

### **Utilizando Webhooks no YoPlanning**

No YoPlanning, os webhooks são particularmente úteis para sistemas de informação que gerenciam pedidos ou rastreiam informações de clientes. Eles permitem:

* **Sincronizar dados:** Garantir que os sistemas externos permaneçam sincronizados com o estado atual dos pedidos e das informações dos clientes, sem a necessidade de consultas constantes.
* **Acompanhe o status do seu pedido:** Receba notificações instantâneas quando pedidos forem criados, modificados ou cancelados, permitindo uma gestão logística ágil e um atendimento ao cliente eficiente.

### **Limitações e disponibilidade**

É importante observar que os webhooks do YoPlanning têm certas limitações. Por exemplo, eles estão disponíveis apenas para eventos relacionados a pedidos e clientes. Se você precisar saber sobre alterações na disponibilidade de um produto ou serviço, deverá consultar a API do YoPlanning diretamente, utilizando o ID do produto em questão.

### **Como acessar webhooks?**

O acesso e a configuração de webhooks no YoPlanning não são automáticos. Requerem uma abordagem personalizada e são tratados caso a caso. Para usar esse recurso, siga estas etapas:

1. **Solicitação de Justificativa:** Parceiros que desejam utilizar webhooks devem enviar uma solicitação justificada ao Suporte da YoPlanning. Essa solicitação deve explicar por que os webhooks são necessários para o sistema de informação deles e como planejam utilizá-los. <support@yoplanning.com>
2. **Validação pela YoPlanning:** O Suporte da YoPlanning analisará cada solicitação para garantir que ela atenda a critérios específicos e para determinar se o uso de webhooks é justificado.
3. **Configuração e Implementação:** Após a aprovação, os parceiros receberão instruções detalhadas sobre como configurar e implementar webhooks em seus sistemas. Será necessário um URL de chamada.

**Para concluir**

Os webhooks oferecem uma solução eficaz para sistemas de informação externos que precisam recuperar informações contábeis ou dados de clientes.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.yoplanning.support/pt/faq-developpeur/faq-utilisation-des-webhooks-dans-yoplanning.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
