Provedor → POST www.example.customer.com

A callback de provedor é acionada sempre que ocorrer uma ação na plataforma relacionada a um provedor. Nesse caso, enviaremos os dados atuais do provedor e a ação realizada.

Ações que acionam a callback:

AçãoAction no JSONQuando ocorre
CriaçãocreateQuando um novo provedor é cadastrado.
EdiçãoupdateQuando algum dado do provedor é alterado.

Exemplo de envio:

{
    "customer": {
        "document": "32704094000176",
        "name": "Live Fast Web",
        "email": "[email protected]",
        "billing_email": "[email protected]",
        "support_email": "[email protected]",
        "municipal_registration": "34754071",
        "state": "RJ",
        "city": "Itaguaí",
        "zip_code": "23812575",
        "address": "Rua Antônia Barbosa Cunha",
        "district": "Centro",
        "number": "70",
        "complement": "Quadra 18",
        "telephone": "+552198765-1240",
        "telephone2": "+5521981357840",
        "total_subscribers_base": 300000,
        "plan": "COMUNIDADE ISPs",
        "erp": {
            "name": "Grupo Voalle",
            "connection_data": {
                "URL": "URL",
                "Token": "Token"
            }
        },
        "hub": "HUB 12",
        "status": "active",
        "has_unpaid_bills": false,
        "customer_success": {
            "name": "Zemlak II",
            "email": "[email protected]",
            "telephone": "+5596937366907"
        }
    },
    "response": "success",
    "action": "create",
    "is_integration_active": true,
    "access_token": "9632947623746c029a51d613fcf4a303f57b99db7ec48f645ed7e76685e6bde9823a66f47",
    "token": "c029a51d613fcf4a303f57b99db7ec48f645ed7e76685e6bde9823a66f47",
    "partner": "celeti"
}

Descrição dos campos da callback:

CampoTipoDescrição
customerobjectDados do provedor.
customer.documentstringCNPJ.
customer.namestringNome.
customer.emailstringE-mail principal.
customer.billing_emailstringE-mail utilizado para assuntos relacionados a faturamento.
customer.support_emailstringE-mail utilizado para assuntos relacionados ao suporte.
customer.municipal_registrationstringInscrição municipal.
customer.statestringSigla do estado (UF) onde o provedor está localizado.
customer.citystringCidade onde o provedor está localizado.
customer.zip_codestringCEP do endereço.
customer.addressstringLogradouro do endereço.
customer.districtstringBairro do endereço.
customer.numberstringNúmero do endereço.
customer.complementstring|nullComplemento do endereço, quando houver.
customer.telephonestringTelefone principal do cliente.
customer.telephone2string|nullTelefone secundário do cliente, quando houver.
customer.total_subscribers_baseintegerQuantidade total aproximada de assinantes que fazem parte da base do provedor.
customer.planstringPlano contratado.
customer.erpobjectInformações sobre o ERP utilizado, quando aplicável.
customer.erp.namestringNome do ERP.
customer.erp.connection_dataobjectDados necessários para estabelecer a conexão com o ERP. Os campos presentes nesse objeto variam conforme o ERP utilizado.
customer.hubstringIdentificação do Hub associado ao provedor, quando aplicável.
customer.statusstringStatus atual.
customer.has_unpaid_billsbooleanIndica se o provedor possui faturas em aberto.
customer.customer_successobjectDados do Sucesso do cliente responsável pelo provedor.
customer.customer_success.namestringNome do responsável.
customer.customer_success.emailstringE-mail do responsável.
customer.customer_succes.telephonestringTelefone do responsável.
responsestringIndica o resultado da operação.
actionstringIndica a ação realizada.
is_integration_activebooleanIndica se a integração do cliente está ativa.
access_tokenstringAccess token, para autenticação na API, associado ao provedor.
tokenstringToken que deve ser utilizado no processo de autenticação da callback.
partnerstringIdentificação do parceiro (nossa identificação - celeti).

Did this page help you?