Sobre os webhooks de vendedores
Webhooks de Vendedores
Os webhooks permitem cadastrar URLs para receber notificações relacionadas às operações realizadas pelo vendedor.
Cada webhook fica associado a um vendedor e pode ser consultado, atualizado ou removido por meio das rotas disponíveis nesta seção.
Operações disponíveis
| Operação | Método | Descrição |
|---|---|---|
| Consultar um Webhook | GET | Retorna os dados de um webhook específico. |
| Consultar Webhooks Vendedores | GET | Retorna os webhooks cadastrados para os vendedores. |
| Criar Webhook Vendedor | POST | Cadastra um novo webhook para um vendedor. |
PUT | ||
| Deletar Webhook Vendedor | DELETE | Remove um webhook cadastrado. |
Fluxo recomendado
- Cadastre o vendedor.
- Crie um webhook informando a URL que receberá as notificações.
- Consulte o webhook para verificar os dados cadastrados.
- Atualize a configuração quando houver alteração na URL.
- Remova o webhook quando ele não for mais utilizado.
Configuração do webhook
Antes de cadastrar um webhook, disponibilize uma URL capaz de receber e processar as notificações enviadas pela plataforma.
A URL deve estar acessível para que a Cyclopay consiga realizar o envio das notificações.
Quando necessário, utilize o identificador do vendedor retornado pelas rotas de criação ou consulta de vendedores.