Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Webhook

Adicionar webhook

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta API é responsável por adicionar um novo webhook

post/webhooks

Headers

emailstring string required
Example:email@email.com

E-mail de autenticação no Construtor de Vendas

tokenstring string required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no Construtor de Vendas

Request body

nomestring required
funcionalidade'AG' | 'AS' | 'AT' | 'CI' | 'CL' | 'CM' | 'CR' | 'CV' | 'EC' | 'EV' | 'LD' | 'PR' | 'RP' | 'RS' | 'UN' required

Informações das funcionalidades e gatilhos disponíveis no endpoint /webhook/gatilhos Códigos de funcionalidades: - AG: Agendamento - AS: Assistência - AT: Atendimento - CI: Contrato por Imobiliária - CL: Cliente - CM: Comissão - CR: Corretor - CV: Contrato de Venda - EC: Envio de Comissão - EV: Espelho de Vendas - LD: Leads - PR: Pré-cadastros - RP: Repasse - RS: Reservas - UN: Unidades

enderecostring required
gatilhointeger required

Informações das funcionalidades e gatilhos disponíveis no endpoint /webhook/gatilhos

ativoPainelboolean required

Example request

{
  "nome": "Webhook",
  "funcionalidade": "AS",
  "endereco": "https://webhook.com.br",
  "gatilho": 1,
  "idempreendimento": [
    1,
    2
  ],
  "idassunto": [
    1,
    2
  ],
  "idsubassunto": [
    1,
    2
  ]
}

Response

Usuário cadastrado com sucesso!

statusstring

Example response

{
  "data": {
    "id": 123
  },
  "status": "success"
}