# Configs
Gerenciar configurações da conta, incluindo a URL do webhook para receber notificações em tempo real.
## Obter configuração do webhook
> Recupera a URL do webhook configurada para a conta WhatsApp Business.\
> O endpoint de webhook recebe notificações em tempo real sobre eventos.\
> \
> \## Eventos do Webhook\
> \
> O webhook recebe notificações para:\
> \
> \| Tipo de Evento | Descrição |\
> \|---------------|-----------|\
> \| messages | Mensagens recebidas de usuários |\
> \| message\_status | Atualizações de status de entrega (sent, delivered, read, failed) |\
> \| message\_template\_status | Notificações de aprovação ou rejeição de templates |\
> \| phone\_number\_quality\_update | Alterações na classificação de qualidade do número |\
> \| phone\_number\_name\_update | Status de aprovação do nome de exibição |\
> \| account\_alerts | Notificações em nível de conta |\
> \| flows | Eventos e respostas de WhatsApp Flows |\
> \
> \## Formato do Payload do Webhook\
> \
> Todos os payloads de webhook seguem a estrutura JSON padrão com os campos \`object\` e \`entry\`.
```json
{"openapi":"3.0.3","info":{"title":"Fortics BSP - API do WhatsApp Business","version":"1.2.0"},"tags":[{"name":"configs","description":"Gerenciar configurações da conta, incluindo a URL do webhook para receber\nnotificações em tempo real.\n"}],"servers":[{"url":"{baseUrl}","description":"Servidor da API BSP","variables":{"baseUrl":{"default":"https://waba.fortics.com.br/v1","description":"URL base da API - Use a URL do servidor que lhe foi atribuída"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey","description":"Chave de API para autenticação"}},"responses":{"WebhookResponse":{"description":"URL do webhook recuperada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL do webhook atualmente configurada"}}}}}},"Unauthorized":{"description":"Não autorizado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}}},"schemas":{"UnauthorizedResponse":{"type":"object","description":"Resposta de erro para falhas de autenticação. Verifique a configuração da chave de API se receber esta resposta.\n","properties":{"message":{"type":"string","description":"Mensagem de erro legível descrevendo a falha de autenticação.\nCausas comuns:\n- Chave de API não incluída na requisição\n- Chave de API inválida ou expirada\n- Chave de API sem permissão para esta operação\n"},"code":{"type":"string","description":"Código de erro para tratamento programático"}}}}},"paths":{"/configs/webhook":{"get":{"tags":["configs"],"summary":"Obter configuração do webhook","description":"Recupera a URL do webhook configurada para a conta WhatsApp Business.\nO endpoint de webhook recebe notificações em tempo real sobre eventos.\n\n## Eventos do Webhook\n\nO webhook recebe notificações para:\n\n| Tipo de Evento | Descrição |\n|---------------|-----------|\n| messages | Mensagens recebidas de usuários |\n| message_status | Atualizações de status de entrega (sent, delivered, read, failed) |\n| message_template_status | Notificações de aprovação ou rejeição de templates |\n| phone_number_quality_update | Alterações na classificação de qualidade do número |\n| phone_number_name_update | Status de aprovação do nome de exibição |\n| account_alerts | Notificações em nível de conta |\n| flows | Eventos e respostas de WhatsApp Flows |\n\n## Formato do Payload do Webhook\n\nTodos os payloads de webhook seguem a estrutura JSON padrão com os campos `object` e `entry`.\n","operationId":"getWebhookUrl","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Definir configuração do webhook
> Configura a URL do webhook para receber notificações em tempo real do WhatsApp.\
> O endpoint do webhook deve estar acessível publicamente e configurado corretamente.
```json
{"openapi":"3.0.3","info":{"title":"Fortics BSP - API do WhatsApp Business","version":"1.2.0"},"tags":[{"name":"configs","description":"Gerenciar configurações da conta, incluindo a URL do webhook para receber\nnotificações em tempo real.\n"}],"servers":[{"url":"{baseUrl}","description":"Servidor da API BSP","variables":{"baseUrl":{"default":"https://waba.fortics.com.br/v1","description":"URL base da API - Use a URL do servidor que lhe foi atribuída"}}}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey","description":"Chave de API para autenticação"}},"responses":{"Created":{"description":"Recurso criado com sucesso"},"Unauthorized":{"description":"Não autorizado.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}}}},"schemas":{"UnauthorizedResponse":{"type":"object","description":"Resposta de erro para falhas de autenticação. Verifique a configuração da chave de API se receber esta resposta.\n","properties":{"message":{"type":"string","description":"Mensagem de erro legível descrevendo a falha de autenticação.\nCausas comuns:\n- Chave de API não incluída na requisição\n- Chave de API inválida ou expirada\n- Chave de API sem permissão para esta operação\n"},"code":{"type":"string","description":"Código de erro para tratamento programático"}}}}},"paths":{"/configs/webhook":{"post":{"tags":["configs"],"summary":"Definir configuração do webhook","description":"Configura a URL do webhook para receber notificações em tempo real do WhatsApp.\nO endpoint do webhook deve estar acessível publicamente e configurado corretamente.\n","operationId":"setWebhookUrl","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"URL HTTPS para envio dos eventos de webhook.\nDeve ser publicamente acessível e possuir certificado SSL válido.\n"}}}}}},"responses":{"201":{"$ref":"#/components/responses/Created"},"400":{"description":"URL de webhook inválida","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
---
# Agent Instructions: 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:
```
GET https://docs.fortics.com.br/bsp-api-reference/reference/configs.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.