{"id":18613072,"url":"https://github.com/eduzz/webhook","last_synced_at":"2026-01-24T18:02:08.808Z","repository":{"id":41867188,"uuid":"178292139","full_name":"eduzz/webhook","owner":"eduzz","description":"Consulte a nova documentação em: https://developers.eduzz.com/","archived":false,"fork":false,"pushed_at":"2024-06-03T11:43:37.000Z","size":270,"stargazers_count":13,"open_issues_count":4,"forks_count":7,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-05-13T14:35:03.719Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developers.eduzz.com/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eduzz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-28T22:32:47.000Z","updated_at":"2024-12-11T13:24:14.000Z","dependencies_parsed_at":"2023-01-30T01:30:47.090Z","dependency_job_id":"391c0b1f-9e5b-4d0f-9d1f-3b3bd820fd64","html_url":"https://github.com/eduzz/webhook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eduzz/webhook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fwebhook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fwebhook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fwebhook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fwebhook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eduzz","download_url":"https://codeload.github.com/eduzz/webhook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Fwebhook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28733303,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T17:51:25.893Z","status":"ssl_error","status_checked_at":"2026-01-24T17:50:48.377Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T03:19:43.222Z","updated_at":"2026-01-24T18:02:08.737Z","avatar_url":"https://github.com/eduzz.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Webhook Eduzz (Obsoleto)\n\n\u003e **Atenção!**\n\u003e Essa versão do webhook deixará de funcionar em breve!.\n\u003e A Eduzz já lançou uma nova versão do sistema de webhooks. Mais moderna, confiável e eficiente. **[Acesse a documentação aqui](https://developers.eduzz.com/)**\n\n## Configurando uma nova integração\n\nPara configurar uma nova integração, basta conferir a **[tela de configuração de webhook](https://orbita.eduzz.com/producer/webhook)** no Órbita, lá, é possível cadastrar uma integração, informando um nome, o tipo de evento que você quer receber, a url desejada, e quais os produtos devem serem enviados.\n\n![Print do formulário de criação de url](./images/formulario_nova_url.png)\n\nOs seguintes campos estão disponíveis para identificação da sua integração:\n\n### Nome\nIdentifica a sua integração na listagem de webhooks no Órbita\n\n### Tipo\nOs seguintes eventos de webhook estão disponíveis:\n\n**Fatura**: É enviado toda vez que um contrato ou uma fatura for atualizado, exemplo, toda vez que um contrato é criado, atualizado, etc, os eventos enviados estão disponíveis na **tabela de eventos**, os campos enviados podem serem conferidos na documentação dos **campos do evento de abandono de carrinho**.\n\n**Abandono de carrinho**: É enviado toda vez que um novo abandono de carrinho é identificado, os campos disponíveis podem serem conferidos na documentação dos **campo do evento de abandono de carrinho**.\n\n### Produtos\n\nOs eventos de quais produtos devem serem enviados para aquela url\n\n### Formato da resposta (Content-Type)\n\nQual será o formato em que os dados serão enviados na requisição http, os seguintes formatos estão disponíveis:\n\n- **[application/json](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Objects/JSON)**\n- **[x-www-form-urlencoded](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)**\n\n## Teste\n\nApós serem preenchidos os dados, a url pode ser testada para verificar se o cadastro foi feito corretamente.\n\nSó será possível salvar se a URL retornar status padrão 200 ([https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200)).\n\n![Print do teste no formulário de criação de url](./images/formulario_teste_url.png)\n\n## Campos extras\n\nParâmetros | Descrição | Tipo\n---------- | --------- | ----\norigin     | **[Token](https://orbita.eduzz.com/producer/config-api)** de segurança do webhook | string\ntype       | Tipo da integração (invoice, contract ou abandonment) | string\nevent_name | Nome do evento | string\n\n## Eventos disponíveis\n\n### Dados e exemplos\n\n- *Atualização de status de fatura e criação de contrato (invoice ou contract)*\n- *Abandono de carrinho (abandonment)*\n\nO tipo **(invoice, contract ou abandonment)** será enviado no campo **(type)**.\n\nQuando utilizando o webhook, para que você possa receber as duas integrações, é necessário cadastrar duas vezes a mesma url para os tipos de fatura/contrato e abandono.\n\nType | Descrição\n--------- | ----\nabandonment | Um evento de abandono de carrinho, **[a documentação pode ser conferida aqui](campos-abandono.md)**\ninvoice | Um evento de alteração do status de uma fatura ou a criação de uma, **[a documentação pode ser conferida aqui](campos-fatura.md)**\ncontract | Um evento de alteração do status de um contrato ou a criação de um, **[a documentação pode ser conferida aqui](campos-fatura.md)**\n\n## Campos e exemplos\n\n### **[Campos enviados para webhooks de fatura e contrato](campos-fatura.md)**\n### **[Campos enviados para webhooks de abandono de carrinho](campos-abandono.md)**\n\n### Eventos\n\nO nome do evento que aconteceu será enviado no campo **event_name**.\n\nOs seguintes valores pode serem enviados para cada tipo de url cadastrada:\n\n**Fatura**\n\nevent_name | Momento do envio\n--- | ---\ninvoice_open | Quando uma fatura é aberta (boleto é gerado ou uma nova transação de contrato é gerada)\ninvoice_processing | Fatura Está em processamento\ninvoice_paid | Fatura está paga\ninvoice_canceled | Fatura está cancelada\ninvoice_waiting_documents | Fatura está aguardando os documentos para processo de reembolso\ninvoice_waiting_refund | Reembolso foi aprovado e a fatura está agurdando ser reembolsada\ninvoice_refunded | Fatura foi reembolsada\ninvoice_analysing | Fatura está em análise\ninvoice_duplicated | Fatura foi identificada como duplicada e foi cancelada\ninvoice_expired | Data de pagamento da fatura expirou\ninvoice_recovering | Fatura entrou em recuperação de Vendas\ninvoice_trial | Fatura entrou em modo de trial\ninvoice_deleted | Fatura foi excluída, contatar time de Suporte\ninvoice_waiting_payment | Fatura está aguardando pagamento\ninvoice_refused | Cartão de crédito recusado no meio de pagamento\ninvoice_overdue | Fatura expirou\ninvoice_scheduled | Fatura está agendada para alguma data específica\ninvoice_negociated | Fatura entrou em disputa pelo cliente\ncontract_up_to_date | Enviado quando o contrato está em dia (foi pago e processado corretamente no último pagamento)\ncontract_waiting_payment | Contrato está aguardando o pagamento da parcela atual\ncontract_suspended | Contrato foi suspenso pela Eduzz ou produtor\ncontract_canceled | Contrato foi cancelado pela Eduzz ou produtor\ncontract_delayed | Contrato será processado no futuro\ncontract_finished | Contrato encerrado\ncontract_trial | Contrato entrou em modo trial\ncontract_overdue | Contrato entrou em atraso\ncontract_free | Contrato é gratuito\n\n**Abandono de Carrinho**\n\nevent_name | Momento do envio\n--- | ---\ncart_abandonment | Toda vez que um cliente preenche os dados no checkout e abandono a compra\n\n## Autenticação\n\nPara autenticar um **[Webhook](https://orbita.eduzz.com/producer/webhook)** na Eduzz, recomendamos o uso do campo chave de origem, disponível tanto no **[Webhook](https://orbita.eduzz.com/producer/webhook)** quanto no serviço de **[Entrega Customizada](https://github.com/eduzz/custom-delivery)**.\n\nA chave para integração com o webhook pode ser visualizada em nossa plataforma no **[Órbita](https://orbita.eduzz.com/producer/config-api)**, ela será enviada no campo origin no payload do webhook.\n\n**Ainda enviamos o campo api_key por motivos de compatibilidade, porém, ele não deve mais ser utilizado e será descontiunado em breve.**\n\n## Guia de solução de problemas\n\nSempre ocorrerá erro de envio quando a URL cadastrada pelo produtor no webhook retornar qualquer status diferente da faixa de **200-299**. [https://developer.mozilla.org/en-US/docs/Web/HTTP/Status](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)\n\nQuando isso ocorrer o serviço de webhook da Eduzz irá realizar 10 tentativas de envio do evento que falhou para a URL, caso a falha continue será marcada como falhando a URL, e os eventos futuros serão armazenado em um backup.\n\nO serviço de webhook continuará disparando o primeiro evento que falhou durante 2 dias, até que a URL do produtor seja reestabelecida, assim que esse disparo retornar status code 200 novamente, o webhook irá reativar a URL e buscar todos os eventos salvos no backup  disparando eles novamente por ordem da data em que os eventos aconteceram.\n\nCaso continue falhando após os 5 dias, a URL será desativada, os eventos salvos serão excluídos e o produtor notificado.\n\n## Suporte\n\nUsuários com problemas no webhook podem utilizar o suporte através dos nossos canais de atendimento no **[Órbita](https://orbita.eduzz.com)**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Fwebhook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feduzz%2Fwebhook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Fwebhook/lists"}