Run in Postman
- Configurar seu aplicativo público com webhooks de extensão de videoconferência. Você configurará seu aplicativo com os URIs que o HubSpot vai usar para notificar você quando reuniões estiverem sendo criadas, atualizadas ou excluídas.
- Configurar um back-end personalizado para lidar com a criação de reuniões e atualizar os webhooks.
- Se necessário, configurar seu back-end para lidar com webhooks de verificação de identificação do usuário.
hapikey no final do URL de solicitação. Você pode encontrar sua chave de API de desenvolvedor em sua conta de desenvolvedor.
Pré-requisitos
Antes de começar, verifique se você criou uma conta de desenvolvedor e um aplicativo público dentro dela.Configurar URLs de webhook
Para que o HubSpot saiba para onde enviar notificações quando as reuniões forem criadas, atualizadas ou excluídas, você primeiro configurará os URLs de webhook da extensão. Para fazer isso, faça uma solicitaçãoPUT para /crm/v3/extensions/videoconferencing/settings/{appId}?hapikey=YOUR_HUBSPOT_DEVELOPER_API_KEY.
No corpo da solicitação, será necessário incluir createMeetingUrl para definir o URL ao qual o HubSpot enviará as cargas do webhook de criação de reunião. Opcionalmente, você pode incluir URLs de webhook adicionais. Esses valores podem ser atualizados posteriormente usando o mesmo URL de solicitação.
Exemplo de resposta:
Recuperar URLs de webhook
Para recuperar URLs de webhook configurados para um aplicativo existente, faça uma solicitaçãoGET para /crm/v3/extensions/videoconferencing/settings/{appId}.
A resposta incluirá os URLs de webhook configurados no momento.
Cargas de webhooks
Depois que os URLs de webhook forem configurados, o HubSpot enviará cargas para esses URLs quando ocorrer um evento de criação, atualização ou exclusão de reunião.Todos os webhooks enviados pelo HubSpot são assinados pelo HMAC usando o segredo do seu aplicativo. Saiba mais sobre isso na documentação de segurança de webhooks (o restante da página não se aplica a estes webhooks de extensão de videoconferência).
Criar webhook de reunião
Quando uma reunião é criada, o HubSpot enviará uma solicitação para o URL especificado no campocreateMeetingUrl. A carga da solicitação inclui informações sobre a conta da HubSpot, o usuário associado e detalhes da reunião.
Para lidar com este webhook, você deve gerar uma videoconferência para essa reunião (ou link para uma linha de conferência existente) e responder às informações sobre essa conferência. Os campos esperados na resposta são:
conferenceId: um ID exclusivo associado à conferência neste evento. Esse ID precisa ser globalmente exclusivo no seu sistema. O HubSpot vai retornar este ID de volta a você no webhook de atualização.conferenceUrl:o URL que os usuários podem usar para ingressar na conferência.conferenceDetails: informações de “convite” em texto simples. Ele deve descrever como os participantes do evento podem acessar a videoconferência desse evento. Novas linhas serão mantidas em representações deste texto, mas nenhuma outra formatação é suportada.
Atualizar o webhook de reunião
Se você especificar umupdateMeetingUrl, a HubSpot enviará uma solicitação a essa URI sempre que os detalhes relevantes da reunião forem alterados. Essa notificação é necessária se você precisar manter o tópico ou horários mais atualizados para uma videoconferência. A carga da solicitação inclui informações sobre a conta da HubSpot, o usuário associado e detalhes da reunião.
Nenhum corpo de resposta é obrigatório ao responder a essas solicitações. Apenas um código de resposta
200 ou 204 é obrigatório para que o HubSpot saiba que esse webhook foi recebido com sucesso.
Excluir webhook de reunião
Quando uma reunião é excluída no HubSpot, uma solicitação é enviada para o URL especificado no campodeleteMeetingUrl. A carga incluirá conferenceId da reunião excluída.
200 ou 204 é obrigatório para que o HubSpot saiba que esse webhook foi recebido com sucesso.
Webhook de verificação do usuário
Os sistemas da HubSpot sempre se comunicam com você sobre seus usuários em termos do seu ID de usuário do HubSpot e seu endereço de e-mail de conta da HubSpot. Há uma chance de um usuário no sistema da HubSpot existir no seu sistema com um endereço ou identificador de e-mail diferente. Antes de o HubSpot fazer uma chamada para o seu sistema para criar, atualizar ou excluir um link de videoconferência, primeiro ele verificará as configurações do aplicativo para um campouserVerifyUrl. Se esse URL tiver sido definido, o HubSpot fará uma chamada para ele para recuperar seu identificador de usuário nativo. Vamos enviar esse identificador como o endereço de e-mail do usuário na chamada subsequente. Se você não configurou esse URL, o HubSpot sempre vai supor que a identidade do usuário foi verificada.
Essa configuração é opcional e cabe a você determinar se ela é necessária. Se precisar manter um mapeamento de usuário no seu sistema, você pode simplesmente mapear o ID ou e-mail do usuário do HubSpot para seu ID de usuário interno em cada chamada.
A carga deste webhook contém o ID da conta da HubSpot e o Endereço de e-mail do usuário.
200 ou qualquer outro código de erro (404 seria apropriado). Se retornar 200, você deve retornar a uma carga útil que contém o novo ID que devemos usar no lugar do endereço de e-mail: