Tipos de hooks disponíveis:

Clientes

"CUSTOMER_CREATED": Sempre que um cliente é criado.

"CUSTOMER_UPDATED": Sempre que um cliente é atualizado.

"CUSTOMER_REMOVED": Sempre que um cliente é removido.

"CUSTOMER_DISABLED": Sempre que um cliente é desativado.

"CUSTOMER_ENABLED": Sempre que um cliente é ativado.


JSON enviado na notificação:

Os dados complementares destes recursos devem ser buscados via APIs do Sienge

{ "customerId" : int }

Contratos de Venda

"SALES_CONTRACT_CREATED": Sempre que um contrato de venda é criado.

"SALES_CONTRACT_UPDATED": Sempre que um contrato de venda é atualizado (não recebe esse evento quando o contrato é emitido).

"SALES_CONTRACT_REMOVED": Sempre que um contrato de venda é removido.

"SALES_CONTRACT_ISSUED": Sempre que um contrato de venda é emitido.

"SALES_CONTRACT_CANCELED": Sempre que um contrato de venda é cancelado.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "salesContractId" : int }

Unidades

"UNIT_CREATED": Sempre que uma unidade é criada.

"UNIT_UPDATED": Sempre que uma unidade é atualizada.

"UNIT_REMOVED": Sempre que uma unidade é removida.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "unitId": int }

Comissões de vendas (Controle de comissões)

"SALES_COMMISSION_CREATED": Sempre que uma comissão de vendas é criada.

"SALES_COMMISSION_INSTALLMENTS_AUTHORIZED": Sempre que uma parcela da comissão de vendas é autorizada.

"SALES_COMMISSION_INSTALLMENTS_CANCELED": Sempre que uma parcela da comissão de vendas é cancelada.

"SALES_COMMISSION_INSTALLMENTS_RELEASED": Sempre que uma parcela da comissão de vendas é liberada.

"SALES_COMMISSION_RELEASES_EXCLUDED": Sempre que uma liberação da parcela da comissão de vendas é excluída.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId" : int }

Gestão de comissões

"SALES_COMMISSION_CREATED": Sempre que uma comissão de vendas é criada.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "commissionsBillId": [int] }

"SALES_COMMISSION_INSTALLMENTS_AUTHORIZED": Sempre que uma parcela da comissão de vendas é autorizada.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "authorize": boolean, "installmentsNumber": [int] }

"SALES_COMMISSION_INSTALLMENTS_CANCELED": Sempre que uma parcela da comissão de vendas é cancelada.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "cancel": boolean, "installmentsNumber": [int] }

"SALES_COMMISSION_INSTALLMENTS_RELEASED": Sempre que uma parcela da comissão de vendas é liberada.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "commissionBillId": int, "installmentsNumber": [int], "comissionReleasedId": int, "comissionReleasedBillId": int }

"SALES_COMMISSION_RELEASES_EXCLUDED": Sempre que uma liberação da parcela da comissão de vendas é excluída.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "commissionBillId": int, "installmentNumber": int, "comissionExcludedId": int, "comissionExcludedBillId": int, }

"SALES_COMMISSION_EXCLUDED": Sempre que uma comissão de vendas é excluída.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "commissionId": int, "commissionBillId": int }

Empreendimento

"COST_CENTER_CREATED": Sempre que um centro de custo é criado.

"COST_CENTER_UPDATED": Sempre que houver uma atualização na Aba "Centro de Custo" dentro do cadastro do empreendimento.

"COST_CENTER_REMOVED": Sempre que um centro de custo é removido.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "costCenterId": int }

"ENTERPRISE_ID_UPDATED": Sempre que o código do empreendimento é alterado.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "previousEnterpriseId": 0, "currentEnterpriseId": 0, "updatedAt": "", "user": "" }

Solicitações de Compra

"PURCHASE_REQUEST_ITEM_AUTHORIZATION_UPDATE": Sempre que houver uma atualização na autorização de um item de solicitação de compra.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int, "purchaseRequestItemNumber" : int, "authorized": boolean, "disapproved": boolean }

"PURCHASE_REQUEST_ITEM_CREATED": Sempre que for criado um item de solicitação de compra.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int, "purchaseRequestItemNumber" : int }

"PURCHASE_REQUEST_ITEM_UPDATED": Sempre que houver uma atualização de um item de solicitação de compra.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int, "purchaseRequestItemNumber" : int }

"PURCHASE_REQUEST_ITEM_DELETED": Sempre que um item de solicitação de compra for deletado.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int, "purchaseRequestItemNumber" : int }

"PURCHASE_REQUEST_DELETED": Sempre que uma solicitação de compras for removida.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int}

"PURCHASE_REQUEST_UPDATED": Sempre que uma solicitação de compras for atualizada.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "purchaseRequestId" : int}

Pedidos de compra

"PURCHASE_ORDER_AUTHORIZATION_CHANGED": Sempre que a autorização do pedido de compra mudar.

JSON enviado na notificação:

O campo 'changedAt' retorna a data e hora da modificação no formato 'yyyy-MM-dd’T’HH:mm:ss.SSSXXX':

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "purchaseOrderId" : int, "authorized": boolean, "consistent": boolean, "changedAt": string }

"PURCHASE_ORDER_GENERATED_FROM_NEGOCIATION": Sempre que um pedido de compra for gerado a partir de uma negociação.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "purchaseOrderId" : int, "purchaseQuotationId" : int, "supplierId" : int, "negotiationNumber" : int, "authorized": boolean }

"PURCHASE_ORDER_ITEM_MODIFIED": Sempre que tiver alguma alteração nos itens do pedido.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "purchaseOrderId" : int }

Contas a receber

"RECEIVABLE_INSTALLMENT_CREATED": Sempre que uma parcela é criada no contas a receber.

"RECEIVABLE_INSTALLMENT_UPDATED": Sempre que uma parcela é atualizada no contas a receber.

"RECEIVABLE_INSTALLMENT_REMOVED": Sempre que uma parcela é removida no contas a receber.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "receivableId": 0, "installmentId": 0 }

"ASSIGNMENT_RIGHTS_AGREEMENT_UPDATED": Sempre que houver uma alteração de cliente no título através de cessão de direito.


JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "receivableId": 0} (que corresponde ao ID do Título)

{ "dtRightAssignment": 2023-01-01} (que corresponde a data de cessão de direito)

{ "customersIdBefore": [1,2,3]} (que corresponde a lista de ID Cliente(s) antes da cessão de direito)

{ "customersIdAfter": [4,5,6]} (que corresponde a lista de ID Cliente(s) após cessão de direito)


"UPDATE_RECEIVABLE_BILL_SITUATION": Sempre que houver uma alteração na situação de um título.


JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "receivableBillId": [1,2]} (que corresponde a lista de ID dos Títulos)

{ "situation": string} (que corresponde a situação para qual o título foi alterado)


Baixas do contas a receber

"RECEIPT_PROCESSED": Sempre que é realizada uma baixa com o tipo de baixa "Recebimento" ou "Adiantamento".


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": 0, "installmentId": 0 }

Contas a pagar

"PAYMENT_BILL_UPDATED": Sempre que um título é alterado no contas a pagar.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": int }

"PAYMENT_INSTALLMENT_CREATED": Sempre que uma parcela é criada no contas a pagar.

"PAYMENT_INSTALLMENT_UPDATE": Sempre que uma parcela é alterada no contas a pagar.

"PAYMENT_INSTALLMENT_REMOVED": Sempre que uma parcela é removida no contas a pagar.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": int, "installmentId": int, "billOrigin": string, "documentType": string }

"PAYMENT_AUTHORIZATION_AVAILABLE": Sempre que uma parcela do contas a pagar fica disponível para autorização.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "billId": int, "installmentId": int, "authorized": boolean }

"PAYMENT_AUTHORIZATION_UPDATE": Sempre que é aprovado ou reprovado a autorização de pagamento de uma parcela no contas a pagar.

JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": int, "installmentId": int, "billOrigin": string, "documentType": string, "authorized": boolean }

Baixas do contas a pagar

"PAYMENT_RECEIPT_PROCESSED": Sempre que uma baixa é realizada".

"PAYMENT_RECEIPT_UPDATED": Sempre que uma baixa é alterada".

"PAYMENT_RECEIPT_REMOVED": Sempre que uma baixa é cancelada".


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": int, "installmentId": int, "billOrigin": string, "documentType": string }

"PAYMENT_RECEIPT_CHARGEBACK_PROCESSED": Sempre que um estorno da baixa é realizado".

"PAYMENT_RECEIPT_CHARGEBACK_REMOVED": Sempre que um estorno da baixa é cancelado".


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": int, "installmentId": int }

Movimentações Bancárias

"BANK_MOVEMENT_CREATED": Sempre que uma movimentação é criada".

"BANK_MOVEMENT_UPDATED": Sempre que uma movimentação é alterada".

"BANK_MOVEMENT_DELETED": Sempre que uma movimentação é cancelada".


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "bankMovementId": int }

Cobrança escritural

"BOOK_COLLECTION_CONFIRMED": Sempre que é realizada a confirmação da cobrança e o nosso número é vinculado a cobrança gerada.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "billId": 0, "installmentId": 0, "banknumber": "0" }

"COLLECTION_NOTIFIED": Sempre que é gerado um histórico de notificação de cobrança, realizada pela rotina de configuração de notificação de cobrança.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{"collectionHistoryId" : int}

Registo de Boleto

"PAYMENT_SLIP_REGISTERED": Sempre que é realizada a confirmação ou rejeição da cobrança pelo banco.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

Exemplo de Cobrança Confirmada:

{ "receivableBillId": 100, "installmentId": 5, "accountNumber":"1234-5", "status": "CONFIRMED" }

Exemplo de Cobrança Rejeitada:

{ "receivableBillId": 100, "installmentId": 5, "accountNumber":"1234-5", "status":"REJECTED" }

Contratos do Suprimentos

"CONTRACT_AUTHORIZED": Sempre que um contrato é totalmente autorizado, ou seja, não é notificado a cada autorização de alçada, mas somente quando não restam autorizações pendentes;


"CONTRACT_UNAUTHORIZED": Sempre que um contrato é desautorizado.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "documentId": "string", "contractNumber": "string" }

Medição de Contratos

"MEASUREMENT_AUTHORIZED": Sempre que uma medição consistente é totalmente autorizada.


"MEASUREMENT_UNAUTHORIZED": Sempre que uma medição consistente é desautorizada.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "documentId": "string", "contractNumber": "string", "measurementNumber": int, "buildingId": int }

Liberação de Medição

"CLEARING_FINISHED": Sempre que uma liberação de medição é finalizada.


"CLEARING_DELETED": Sempre que uma liberação de medição finalizada é deletada.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "documentId": "string", "contractNumber": "string", "buildingId": int, "measurementNumber": int }

Orçamento

"BUILDING_COST_ESTIMATIONS_VERSION_CREATED": Sempre que é gerada uma nova versão do orçamento.


JSON enviado na notificação:

Os dados complementares deste recurso deve ser buscado via APIs do Sienge

{ "buildingId": 0, "buildingStatus": "", "creationDate": "", "versionNumber": 0 }

Status Retornados:

-COST_ESTIMATING: Orçamento

-IN_PROGRESS: Em andamento

-FINISHED_WITH_FINANCIAL_PENDENCIES: Encerrada com pendências financeiras

-FINISHED_WITHOUT_FINANCIAL_PENDENCIES: Encerrada sem pendências financeiras


"BUILDING_COST_ESTIMATION_UPDATED": Sempre que um item de orçamento é criado ou removido.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "buildingId": 0, "buildingUnitId": 0, "updatedAt": "", "user": "" }

Custos Unitários

"RESOURCE_CREATED": Sempre que é criado um novo insumo.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "costDatabaseId": 0, "id": "", "resourceCode": "", "createdAt": "" }

"WORKITEM_CREATED": Sempre que é criado um novo serviço.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "costDatabaseId": 0, "id": 0, "auxiliaryCode": "", "buildingTypeId": "", "createdAt": "" }

Cadastro de Obras

"BUILDING_STATUS_UPDATED": Sempre que a situação da obra é alterada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "buildingId": 0, "updatedAt": "" }

"BUILDING_COST_ESTIMATION_STATUS_UPDATED": Sempre que a situação do orçamento é alterada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "buildingId": 0, "updatedAt": "" }

Plano de Contas Contábil

"ACCOUNTACY_ACCOUNT_UPDATED": Sempre que uma conta contábil é atualizada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "companyId": 0, "accountId": 0 }

"ACCOUNTANCY_ACCOUNT_CREATED": Sempre que uma conta contábil é criada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "companyId": 0, "accountId": 0 }

"ACCOUNTANCY_ACCOUNT_DELETED": Sempre que uma conta contábil é deletada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "companyId": 0, "accountId": 0 }

Fechamento Contábil

"ACCOUNTANCY_CLOSING_CREATED": Sempre que um fechamento contábil é criada.

JSON enviado na notificação:

Os dados complementares deste recurso devem ser buscados via APIs do Sienge

{ "companyId": 0, "closingAt": "" }



Configurando um Webhook.

Para realizar o cadastro de uma notificação de webhook, é necessário fazer uso das APIs deste recurso: (APIs Gerenciamento WebHooks).

A própria natureza do WebHook assume que se possua alguma habilidade em escrever códigos e por este motivo é disponibilizado um conjunto de APIs de gerenciamento de WebHooks, permite inserir, editar, deletar e listar todos os hooks da sua plataforma Sienge.


Para gerenciar as notificações de Webhook você precisará fornecer informações importantes ao Sienge, através das APIs de Webhooks, sendo:

events: Lista de eventos que deseja ser notificado. ex.: [ "USER_CREATED" ]

url: Url para aonde irá submeter os dados da notificação selecionada.