Webhooks

Os webhooks permitem que você receba notificações programáticas da Captei sobre alterações nos seus dados conforme elas acontecem.

Sobre webhooks

Em vez de exigir que você extraia informações por meio de nossa API, os webhooks enviarão informações para seu endpoint. Quando um desses eventos é acionado (por exemplo, uma nova indicação é criada), a Captei enviará esta notificação como uma solicitação HTTP, com um corpo JSON, para o(s) endpoint(s) que você especificar.POST

Você pode criar um novo webhook no backoffice da Captei em Marketing de Indicação > Configurações > Webhooks. O limite máximo de webhooks é de 3 webhooks diferentes por usuário .

• Usuários regulares podem criar/excluir webhooks, se tiver a permissão de Configuração da Conta.

• Os usuários administradores podem gerenciar todos webhooks da empresa.

Esta é a aparência do formulário Criar novo webhook para o usuário Administrador porque o menu suspenso Nível de permissão não está disponível para usuários regulares:

Criação de Webhooks na Plataforma Captei

Eventos na Captei

Os eventos são as ações executadas dentro da Captei que acionaram os webhooks cadastrados pelo cliente.

Nova Indicação	Quando uma indicação é criada na conta do cliente, uma notificação será enviada via webhook, caso um webhook esteja cadastrado para este evento. A notificação incluirá um JSON contendo os dados da nova indicação.
Novo Usuário	Quando um novo usuário for criado na conta do cliente, uma notificação será enviada via webhook, caso um webhook esteja cadastrado para este evento. A notificação incluirá um JSON contendo os dados do novo usuário.
Novo Prêmio Criado	Quando um novo prêmio for gerado na conta do cliente, uma notificação será enviada via webhook, caso um webhook esteja cadastrado para este evento. A notificação incluirá um JSON contendo os dados do novo prêmio.

Formato dos webhooks

Nova Indicação de Proprietário:

{
  "indicacao_id": INTEGER,
  "indicacao_id_cliente": INTEGER,
  "indicacao_nome": VARCHAR,
  "indicacao_telefone": VARCHAR,
  "indicacao_email": VARCHAR,
  "indicacao_endereco_logradouro": VARCHAR,
  "indicacao_endereco_logradouro_numero": VARCHAR,
  "indicacao_endereco_complemento": VARCHAR,
  "indicacao_endereco_bairro": VARCHAR,
  "indicacao_endereco_cidade": VARCHAR,
  "indicacao_endereco_uf": VARCHAR,
  "indicacao_endereco_cep": VARCHAR,
  "indicacao_tipo_imovel": CHAR(1), // R = residencial | C = comercial
  "indicacao_tipo_negocio": CHAR(1), // L = locação | V = venda
  "indicacao_observacao": TEXT,
  "indicacao_data": TIMESTAMP,
  "campanha_id": INTEGER,
  "campanha_nome": VARCHAR,
  "campanha_chave": VARCHAR,
  "status_id": INTEGER,
  "status_nome": VARCHAR,
  "usuario_id": INTEGER,
  "usuario_id_cliente": INTEGER,
  "usuario_nome": VARCHAR,
  "usuario_sobrenome": VARCHAR,
  "usuario_data_nascimento": DATE,
  "usuario_email": VARCHAR,
  "usuario_celular": VARCHAR
}

Nova Indicação de Inquilino ou Comprador:

{
  "indicacao_id": INTEGER,
  "indicacao_id_cliente": INTEGER,
  "indicacao_nome": VARCHAR,
  "indicacao_telefone": VARCHAR,
  "indicacao_email": VARCHAR,
  "indicacao_tipo": CHAR(1), // C = comprador | I = inquilino
  "indicacao_observacao": TEXT,
  "indicacao_data": TIMESTAMP,
  "campanha_id": INTEGER,
  "campanha_nome": VARCHAR,
  "campanha_chave": VARCHAR,
  "status_id": INTEGER,
  "status_nome": VARCHAR,
  "usuario_id": INTEGER,
  "usuario_id_cliente": INTEGER,
  "usuario_nome": VARCHAR,
  "usuario_sobrenome": VARCHAR,
  "usuario_data_nascimento": DATE,
  "usuario_email": VARCHAR,
  "usuario_celular": VARCHAR
}

Novo Usuário:

{
  "usuario_id": INTEGER,
  "usuario_id_cliente": INTEGER,
  "usuario_nome": VARCHAR,
  "usuario_sobrenome": VARCHAR,
  "usuario_data_nascimento": DATE,
  "usuario_email": VARCHAR,
  "usuario_celular": VARCHAR,
  "conta_bancaria_nome_favorecido": VARCHAR,
  "conta_bancaria_documento": VARCHAR,
  "conta_bancaria_data_nascimento": VARCHAR,
  "conta_bancaria_codigo_banco": VARCHAR,
  "conta_bancaria_nome_banco": VARCHAR,
  "conta_bancaria_agencia": VARCHAR,
  "conta_bancaria_conta": VARCHAR,
  "conta_bancaria_tipo_conta": CHAR(1), // P = poupança | C = corrente
  "conta_bancaria_usar_pix": CHAR(1), // S = sim | N = não
  "conta_bancaria_chave_pix": VARCHAR,
  "conta_bancaria_tipo_chave_pix": VARCHAR // CPF/CNPJ | Celular | E-mail | Aleatória
}

Novo Prêmio:

{
  "pagamento_id": INTEGER,
  "pagamento_id_cliente": INTEGET,
  "pagamento_valor": NUMERIC(12,2),
  "pagamento_referencia": VARCHAR,
  "pagamento_situacao": CHAR(1),
  "pagamento_data_prevista": TIMESTAMP,
  "pagamento_data_criacao": TIMESTAMP,
  "indicacao_id": INTEGER,
  "indicacao_id_cliente": INTEGER,
  "indicacao_tipo_indicacao": CHAR(1), // P = proprietário | I = inquilino | C = comprador 
  "usuario_id": INTEGER,
  "usuario_id_cliente": INTEGER,
  "usuario_gerador_pagamento_id": INTEGER,
  "usuario_gerador_pagamento_nome": INTEGER,
  "usuario_gerador_pagamento_sobrenome": VARCHAR,
  "usuario_gerador_pagamento_email": VARCHAR
}

Eventos suportados

• criação

Objetos suportados

• Indicação de Proprietários

• Indicação de Inquilinos e Compradores

• Prêmios

• Usuários