A API do Zenvia Conversion permite notificar sistemas externos sobre eventos específicos na plataforma, utilizando Webhooks.

Um Webhook é uma solicitação HTTP POST enviada para um URL previamente registrado, contendo informações sobre o evento ocorrido.

Eventos disponíveis (Topics)

Os eventos que podem ser notificados incluem:

• Criação de prospect: Envio após receber e validar um lead.
• Atualização de quote: Notificação de alterações de status.
• Resolução de interação: Quando um consultor encerra uma interação.

Como registrar notificações

Para configurar notificações, siga os passos abaixo:

1. Obtenha uma API Key: Necessária para acessar a API.
2. Registre uma assinatura (subscription): Especifique os eventos (Topics) que deseja acompanhar e insira o URL para notificações (callbackURL) na seção Notifications da API.
3. Receba notificações: Sempre que o evento ocorrer, a API enviará uma solicitação HTTP POST para o URL registrado.

Exemplos práticos

Registro de uma assinatura

Para registrar uma assinatura para o evento de criação de um prospect, envie a seguinte solicitação:

POST https://api.zenvia.com/v1/subscriptions  
Content-Type: application/json  
Authorization: Bearer {sua-api-key}  


{  
  "topic": "lead.created",  
  "callbackUrl": "https://seu-sistema.com/webhooks/lead"  
}

Exemplo de Webhook recebido

Quando um prospect for criado, seu sistema receberá uma solicitação HTTP POST com o seguinte corpo:

{  
  "topic": "lead.created",  
  "eventTime": "2024-12-09T15:30:00Z",  
  "data": {  
    "leadId": "12345",  
    "name": "João Silva",  
    "email": "joao.silva@email.com",  
    "phone": "+5511999999999"  
  }  
}

Consulta de assinaturas registradas

Para listar todas as assinaturas existentes, envie a seguinte solicitação:

GET https://api.zenvia.com/v1/subscriptions  
Authorization: Bearer {sua-api-key}  

O retorno será semelhante a:

[  
  {  
    "id": "subscription1",  
    "topic": "lead.created",  
    "callbackUrl": "https://seu-sistema.com/webhooks/lead"  
  },  
  {  
    "id": "subscription2",  
    "topic": "interaction.resolved",  
    "callbackUrl": "https://seu-sistema.com/webhooks/interacao"  
  }  
]

Requisitos

Certifique-se de ter uma API Key ativa para utilizar os recursos da API.