GYRA+ DOCS
...
Webhooks
Criar uma rota
10 min
tipos de webhooks relatórios receber todos os dados do relatório ("report") esse retorno é disparado quando uma seção do relatório é gerada, enviando todos os dados do relatório via api esse retorno é ideal para quem deseja ter todos os dados consumidos salvos no próprio sistema todos os dados podem ser consumidos a qualquer momento através do id na consulta ao relatório docid\ iy1eczyukrmcw8xaxdqhh { "data" { "id" "66e1e3b35613ae88b8b536ff", "integrationcount" 0, "report" { "id" "66e1e3b35613ae88b8b536f1", "document" "09662563000110", "organizationid" "65eb4989a4a87b9a94d1920f", "type" { "id" "6614758260513064a5af1064", "createdat" "2024 04 08t22 53 54 548z", "updatedat" "2024 04 24t18 35 03 774z", "title" "gyra360+", "value" "customer gyra 360 plus company", "ispaid" true }, "status" { "title" "não iniciado", "value" "pending" } }, "type" { "value" "basic information", "integrationtypes" \[ "bdc company basic data", "bdc company history basic data", "bdc company economic group relationship", "lemit" ] }, "sectiondetails" \[ { "errors" \[], "id" "66e1e3b45613ae88b8b53700", "createdat" "2024 09 11t18 38 44 447z", "updatedat" "2024 09 11t18 38 44 447z", "sectionid" "66e1e3b35613ae88b8b536ff", "values" { "lemitprimaryaddress" "r ademar bombo, 380 portao 1 2 e 3 distrito industrial, mogi guacu sp, 13849 224", "lemitprimaryphonenumber" "(19) 99785 3525", "lemitprimaryemail" "junior\@icra com br", "lemitprofession" " ", "lemitsecondarycontacts" \[ { "contacttype" "email", "contact" "asw\@aswbrasil com br" }, { "contacttype" "email", "contact" "rh\@aswbrasil com br" }, { "contacttype" "telefone", "contact" "(19) 99608 6166" }, { "contacttype" "telefone", "contact" "(19) 99883 1747" }, { "contacttype" "telefone", "contact" "(19) 99739 3514" }, { "contacttype" "telefone", "contact" "(19) 99910 7542" }, { "contacttype" "telefone", "contact" "(19) 3851 3080" }, { "contacttype" "telefone", "contact" "(11) 3841 4100" } ], "deceased" "não", "cpfsituation" "" }, "integrationtypes" \[ "lemit" ] }, { "errors" \[], "id" "66e1e3b45613ae88b8b53703", "createdat" "2024 09 11t18 38 44 883z", "updatedat" "2024 09 11t18 38 44 883z", "sectionid" "66e1e3b35613ae88b8b536ff", "values" { "historydata" { "id" "202409 09662563000110", "createdat" "2024 09 11t18 38 44 694z", "updatedat" "2024 09 11t18 38 44 694z", "document" "09662563000110", "yearmonth" 202409, "company" { "historynames" \[ { "id" "66e1e3b4e5607af9ada551a7", "createdat" "2024 09 11t18 38 44 760z", "updatedat" "2024 09 11t18 38 44 760z", "bdccompanyid" "202409 09662563000110", "name" "asw brasil tecnologia em plasticos ltda", "tradename" "", "officialname" "asw brasil tecnologia em plasticos ltda", "changedate" "2019 08 01t00 00 00 000z" } ], "historyactivities" \[ { "id" "66e1e3b4e5607af9ada551ab", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2229399", "docnumber" "00003036000129", "activity" "fabricacao de artefatos de material plastico para outros usos nao especificados anteriormente", "economicactivitydivision" "fabricacao de produtos de borracha e de material plastico", "economicactivitygroup" "fabricacao de produtos de material plastico", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551ac", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2790201", "docnumber" "00024780000100", "activity" "fabricacao de eletrodos, contatos e outros artigos de carvao e grafita para uso eletrico, eletroimas e isoladores", "economicactivitydivision" "fabricacao de maquinas, aparelhos e materiais eletricos", "economicactivitygroup" "fabricacao de equipamentos e aparelhos eletricos nao especificados anteriormente", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551ad", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2790299", "docnumber" "00002776000140", "activity" "fabricacao de outros equipamentos e aparelhos eletricos nao especificados anteriormente", "economicactivitydivision" "fabricacao de maquinas, aparelhos e materiais eletricos", "economicactivitygroup" "fabricacao de equipamentos e aparelhos eletricos nao especificados anteriormente", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551ae", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2229302", "docnumber" "00002455000146", "activity" "fabricacao de artefatos de material plastico para usos industriais", "economicactivitydivision" "fabricacao de produtos de borracha e de material plastico", "economicactivitygroup" "fabricacao de produtos de material plastico", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551af", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4930201", "docnumber" "00000688000100", "activity" "transporte rodoviario de carga, exceto produtos perigosos e mudancas, municipal", "economicactivitydivision" "transporte terrestre", "economicactivitygroup" "transporte rodoviario de carga", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b0", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4930202", "docnumber" "00000917000277", "activity" "transporte rodoviario de carga, exceto produtos perigosos e mudancas, intermunicipal, interestadual e internacional", "economicactivitydivision" "transporte terrestre", "economicactivitygroup" "transporte rodoviario de carga", "ismaineconomicactivity" false, "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b1", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2221800", "docnumber" "00002479000103", "activity" "fabricacao de laminados planos e tubulares de material plastico", "economicactivitydivision" "fabricacao de produtos de borracha e de material plastico", "economicactivitygroup" "fabricacao de produtos de material plastico", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b2", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "2319200", "docnumber" "00006386000149", "activity" "fabricacao de artigos de vidro", "economicactivitydivision" "fabricacao de produtos de minerais nao metalicos", "economicactivitygroup" "fabricacao de vidro e de produtos do vidro", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b3", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4663000", "docnumber" "00000807000124", "activity" "comercio atacadista de maquinas e equipamentos para uso industrial", "economicactivitydivision" "comercio por atacado, exceto veiculos automotores e motocicletas", "economicactivitygroup" "comercio atacadista de maquinas, aparelhos e equipamentos, exceto de tecnologias de informacao e comunicacao", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b4", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4669999", "docnumber" "00000326000119", "activity" "comercio atacadista de outras maquinas e equipamentos nao especificados anteriormente", "economicactivitydivision" "comercio por atacado, exceto veiculos automotores e motocicletas", "economicactivitygroup" "comercio atacadista de maquinas, aparelhos e equipamentos, exceto de tecnologias de informacao e comunicacao", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b5", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4684299", "docnumber" "00006027000191", "activity" "comercio atacadista de outros produtos quimicos e petroquimicos nao especificados anteriormente", "economicactivitydivision" "comercio por atacado, exceto veiculos automotores e motocicletas", "economicactivitygroup" "comercio atacadista especializado em outros produtos", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b6", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4689301", "docnumber" "00001596000144", "activity" "comercio atacadista de produtos da extracao mineral, exceto combustiveis", "economicactivitydivision" "comercio por atacado, exceto veiculos automotores e motocicletas", "economicactivitygroup" "comercio atacadista especializado em outros produtos", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b7", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4744001", "docnumber" "00000463000234", "activity" "comercio varejista de ferragens e ferramentas", "economicactivitydivision" "comercio varejista", "economicactivitygroup" "comercio varejista de material de construcao", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b8", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "4789099", "docnumber" "00000091000165", "activity" "comercio varejista de outros produtos nao especificados anteriormente", "economicactivitydivision" "comercio varejista", "economicactivitygroup" "comercio varejista de produtos novos nao especificados anteriormente e de produtos usados", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551b9", "createdat" "2024 09 11t18 38 44 780z", "updatedat" "2024 09 11t18 38 44 780z", "bdccompanyid" "202409 09662563000110", "code" "6810202", "docnumber" "00000166000108", "activity" "aluguel de imoveis proprios", "economicactivitydivision" "atividades imobiliarias", "economicactivitygroup" "atividades imobiliarias de imoveis proprios", "ismaineconomicactivity" false, "changedate" "2022 06 01t00 00 00 000z" } ], "historytaxregimes" \[ { "id" "66e1e3b4e5607af9ada551a9", "createdat" "2024 09 11t18 38 44 769z", "updatedat" "2024 09 11t18 38 44 769z", "bdccompanyid" "202409 09662563000110", "taxregime" "ltda", "changedate" "2019 08 01t00 00 00 000z" }, { "id" "66e1e3b4e5607af9ada551aa", "createdat" "2024 09 11t18 38 44 769z", "updatedat" "2024 09 11t18 38 44 769z", "bdccompanyid" "202409 09662563000110", "taxregime" "lucro real", "changedate" "2023 02 01t00 00 00 000z" } ] } } }, "integrationtypes" \[ "bdc company history basic data" ] } ] }, "organizationid" "65eb4989a4a87b9a94d1920f" } receber alterações das ("report status") esse retorno é disparado quando um relatório já gerado sofreu alteração em seu status isso pode acontecer nas seguintes situações análise a partir do fluxo de decisão quando a decisão é automática a partir do fluxo de decisão, aprovando ou negando o relatório manualmente ou via via api quando a decisão é feita a partir de uma ação de usuário ou api, aprovando ou negando o relatório alteração de análise a partir da alçada quando um relatório já possui uma análise, porém com a alçada de aprovação sofre uma alteração na análise, aprovando ou negando um relatório já analisado { 	"data" { 	 "reportid" "67afa24bcef9d7fa7c07b8bb", 	 "analysis" { 	 "userid" "665f6579713b076c9bc93b6f", 	 "username" "665f6579713b076c9bc93b6f", 	 "status" "report approved", 	 "date" "665f6579713b076c9bc93b6f" 	 }, 	 "lastanalysis" { 	 "userid" "política de crédito", 	 "username" "política de crédito", 	 "status" "report rejected", 	 "date" "2025 02 14t20 06 58 925z" 	 } 	}, 	"webhooktype" "report status", 	"organizationid" "6602cba04faa2a9211fb6fa6" } receber alerta de relatório concluído ("report finished") esse retorno é disparado quando um relatório tem todas as seções de dados prontas é ideal para quem deseja todos os dados do sistema de uma única vez { "data" { "reportid" "67f02fa838e3138b78dc23e0", "policyid" "6696edd917ab9c70c26a66f8", "isfinalized" true, "finalizedat" "2025 04 04t19 17 02 229z" }, "webhooktype" "report finished", "organizationid" "65eb4989a4a87b9a94d1920f" } fluxos de decisões resultado da política ("credit policy") esse retorno é disparado quando o fluxo de decisão finaliza sua análise, enviando a decisão do fluxo no retorno a decisão do fluxo de decisão não é necessariamente o resultado do relatório isso só é verdade quando o fluxo de decisão tem na sua configuração analisar o relatório o retorno pode ser enviado antes de todo o fluxo de decisão ser analisado, pois, caso exista uma condição de negativa o resultado final já será de negativa (alerta severo) { 	"data" { 	 "reportid" "67afa24bcef9d7fa7c07b8bb", 	 "policyid" "66967e118f7ade828e757c9b", 	 "version" 1 3, 	 "status" "denied", 	 "score" 1000, 	 "date" "2025 02 14t20 06 59 098z" 	}, 	"webhooktype" "credit policy", 	"organizationid" "6602cba04faa2a9211fb6fa6" } autorizações autorização dada pelo cliente ("optin") esse retorno é enviado quando uma autorização é dada ao sistema