--- title: Criar uma rota slug: criar-uma-rota docTags: createdAt: 2024-05-22T14:32:22.062Z --- :::ApiMethodV2 ```json { "name": "Criar nova rota para webhook", "method": "POST", "url": "https://gyra-core.gyramais.com.br/webhook", "description": "Criar uma nova rota para sua organização", "tab": "examples", "examples": { "languages": [ { "id": "NRFjRHX_nsJSREgepTDMe", "language": "curl", "code": "curl --location 'https://gyra-core.gyramais.com.br/webhook' \\\n--header 'authorization: Bearer string' \\\n--data '{\"type\":\"String\",\"url\":\"String\"}'", "customLabel": "" } ], "selectedLanguageId": "NRFjRHX_nsJSREgepTDMe" }, "results": { "languages": [ { "id": "5Dsg6CH__jTzi5F6T8onu", "language": "200", "customLabel": "", "code": "[\n {\n \"id\": \"664f714273d5bf7ee4e6304e\",\n \"createdAt\": \"2024-05-23T16:39:30.597Z\",\n \"updatedAt\": \"2024-05-23T16:39:30.597Z\",\n \"organizationId\": \"6602cba04faa2a9211fb6fa6\",\n \"type\": \"REPORT\",\n \"url\": \"https://\"\n }\n]" } ], "selectedLanguageId": "5Dsg6CH__jTzi5F6T8onu" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "name": "authorization", "kind": "required", "type": "string", "description": "Bearer token", "children": [] } ], "bodyDataParameters": [ { "name": "type", "kind": "required", "type": "string", "description": "Tipos de retorno para a rota \"REPORT\"" }, { "name": "url", "kind": "required", "type": "string", "description": "Rota desejada", "children": [] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "hasTryItOut": false } ``` ::: # 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. :::hint{type="info"} Todos os dados podem ser consumidos a qualquer momento através do ID na [Consulta ao relatório](docId\:Iy1ECZYuKRmcW8xaXdQHH) ::: ```json { "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: 1. 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. 2. 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 3. 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. ```json { "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. ```json { "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. :::hint{type="warning"} 1. 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. 2. 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). ::: ```json { "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. ```json ```