{"id":18613058,"url":"https://github.com/eduzz/eduzz-webhook-docs","last_synced_at":"2025-09-02T01:33:40.412Z","repository":{"id":197788629,"uuid":"682225205","full_name":"eduzz/eduzz-webhook-docs","owner":"eduzz","description":"Documentação do Webhook v3","archived":false,"fork":false,"pushed_at":"2024-07-05T17:27:41.000Z","size":1426,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-05-17T00:36:48.341Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2023-08-23T18:02:16.000Z","updated_at":"2024-07-01T20:43:12.000Z","dependencies_parsed_at":"2024-03-04T17:28:42.615Z","dependency_job_id":"7f89d7ca-cc28-446f-b043-920da237d572","html_url":"https://github.com/eduzz/eduzz-webhook-docs","commit_stats":null,"previous_names":["eduzz/eduzz-webhook-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eduzz/eduzz-webhook-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Feduzz-webhook-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Feduzz-webhook-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Feduzz-webhook-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Feduzz-webhook-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eduzz","download_url":"https://codeload.github.com/eduzz/eduzz-webhook-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eduzz%2Feduzz-webhook-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273218428,"owners_count":25065913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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:42.549Z","updated_at":"2025-09-02T01:33:40.385Z","avatar_url":"https://github.com/eduzz.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Webhook Eduzz\n\nO Webhook da Eduzz permite que você receba requisições **HTTP** em sua aplicação sempre que um novo evento acontecer em sua conta. Você pode configurar uma integração para receber diversos eventos de diversas aplicações diferentes da Eduzz: **https://integrations.eduzz.com/webhook/configs**.\n\n## Eventos e payloads\n\nO formato do json será sempre o seguinte:\n\n```json\n{\n    \"id\": \"z154l2pvk6jltotg0xy86glx\" // id do evento,\n    \"event\": \"nutror.lesson_started\" // nome do evento,\n    \"data\": {}, // dados do evento,\n    \"sentDate\": \"2023-08-31T18:34:23.023Z\" // data do evento\n}\n```\n\nOs eventos disponíveis atualmente são os seguintes:\n\n - **Blinket**\n    - **[attendance_added](./events/blinket/attendance_added.md)**\n    - **[attendance_assigned](./events/blinket/attendance_assigned.md)**\n    - **[attendance_canceled](./events/blinket/attendance_canceled.md)**\n    - **[attendance_edited](./events/blinket/attendance_edited.md)**\n    - **[attendances_printed](./events/blinket/attendances_printed.md)**\n    - **[attendance_checkin](./events/blinket/attendance_checkin.md)**\n    - **[attendance_tag_changed](./events/blinket/attendance_tag_changed.md)**\n    - **[ticket_edited](./events/blinket/ticket_edited.md)**\n\n - **MyEduzz**\n    - **[contract_created](./events/myeduzz/contract_created.md)**\n    - **[contract_updated](./events/myeduzz/contract_updated.md)**\n    - **[invoice_opened](./events/myeduzz/invoice_opened.md)**\n    - **[invoice_paid](./events/myeduzz/invoice_paid.md)**\n    - **[invoice_canceled](./events/myeduzz/invoice_canceled.md)**\n    - **[invoice_waiting_refund](./events/myeduzz/invoice_waiting_refund.md)**\n    - **[invoice_refunded](./events/myeduzz/invoice_refunded.md)**\n    - **[invoice_expired](./events/myeduzz/invoice_expired.md)**\n    - **[invoice_recovering](./events/myeduzz/invoice_recovering.md)**\n    - **[invoice_waiting_payment](./events/myeduzz/invoice_waiting_payment.md)**\n    - **[invoice_refused](./events/myeduzz/invoice_refused.md)**\n    - **[invoice_overdue](./events/myeduzz/invoice_overdue.md)**\n    - **[invoice_scheduled](./events/myeduzz/invoice_scheduled.md)**\n    - **[invoice_negotiated](./events/myeduzz/invoice_negotiated.md)**\n    - **[commission_processed](./events/myeduzz/commission_processed.md)**\n\n - **Nutror**\n    - **[certificate_viewed](./events/nutror/certificate_viewed.md)**\n    - **[comment_created](./events/nutror/comment_created.md)**\n    - **[community_viewed](./events/nutror/community_viewed.md)**\n    - **[enrollment_created](./events/nutror/enrollment_created.md)**\n    - **[file_downloaded](./events/nutror/file_downloaded.md)**\n    - **[inactive_student](./events/nutror/inactive_student.md)**\n    - **[learner_help](./events/nutror/learner_help.md)**\n    - **[lesson_rated](./events/nutror/lesson_rated.md)**\n    - **[lesson_saved](./events/nutror/lesson_saved.md)**\n    - **[lesson_started](./events/nutror/lesson_started.md)**\n    - **[lesson_watched](./events/nutror/lesson_watched.md)**\n    - **[module_completed](./events/nutror/module_completed.md)**\n    - **[notation_created](./events/nutror/notation_created.md)**\n\n## Como configurar um webhook\n\nAo acessar o webhook, a seguinte tela de listagem de configurações será exibida:\n\n![listagem_de_configuracoes_vazia](./images/subscription/empty_list.png)\n\nPara cadastrar uma nova integração, basta acessar o **[formulário de cadastro](https://integrations.eduzz.com/webhook/new)** na tela de listagem de configurações clicando em **\"+ Nova configuração\"**, então, o seguinte formulário será exibido:\n\n![imagem_formulario_cadastro](./images/subscription/form_new_empty.png)\n\nÉ possível para o usuário preencher os seguintes campos:\n\n- **Nome da configuração:** Uma descrição para a sua configuração.\n\n- **Chave de acesso:** Nesse campo, é possível escolher qual chave de autenticação será utilizada para assinar as mensagens que serão enviadas.\n\n- **URL para envio dos dados:** URL para onde os dados serão enviados. É importante realizar um teste para garantir que a URL esteja retornando um status HTTP válido (códigos 200 a 299).\n\n- **Máximo de eventos enviados em paralelo para a URL:** A Eduzz é pioneira no envio controlado de webhooks para os parceiros. Durante um grande lançamento, pode acontecer de a quantidade de envios tornar o seu sistema indisponível. Com essa configuração, você consegue definir um limite de envios e garante que sua aplicação não vai cair devido ao alto volume. Pode ficar tranquilo, você receberá todos os eventos.\n\n- **Quais eventos você deseja receber?:** Você pode escolher quais eventos serão enviados para sua URL, de diversas aplicações.\n\n**Segue exemplo de formulário preenchido:**\n\n![imagem_formulario_cadastro_preenchido](./images/subscription/form_new_filled.png)\n\nNão se esqueça de clicar em **\"Verificar URL\"** para testar se a url retorna status HTTP válido (códigos 200 a 299), caso contrário não será possível cadastrar sua configuração\n\nEntão, basta clicar em \"Criar configuração\" e sua configuração será salva com sucesso.\n\n![imagem_cadastrada_com_sucesso](./images/subscription/list_not_empty.png)\n\n### Ativando uma url\n\nAo criar uma nova configuração, ela é criada com o status **desativado**. Ao clicar na ação de ativar, será enviado um evento falso de **ping**, apenas para verificar se sua API responde corretamente. Caso ela responda, sua configuração será ativada com sucesso.\n\n![imagem_ativada_com_sucesso](./images/subscription/list_not_empty_active.png)\n\n### Histórico de Envios\n\nAo clicar no item \"Histórico de Envios\" no menu, você será direcionado a uma tela com os envios mais recentes para o seu endpoint.\n\nNa tabela, você encontrará alguns detalhes, tais como: Situação do Envio, ID do evento, URL que foi enviada, o tipo de evento e o último status de resposta.\n\n![imagem_historico_envio](./images/history/list.png)\n\nClicando em ações no item da listagem, você poderá reenviar ou visualizar os detalhes do evento.\n\n![imagem_detalhe_envio](./images/history/details.png)\n\nNa tela de detalhes, você encontrará várias informações importantes, como a data do envio, número de tentativas, payload enviado, resposta da sua API, os metadados e o tempo que sua API levou para responder a esse evento.\n\n![imagem_filtros_avançados](./images/history/filters.png)\n\nA tela de histórico também possui diversos filtros para auxiliar na busca por um evento específico. Os filtros avançados oferecem ainda mais possibilidades, permitindo filtrar eventos por metadados, situações, configurações específicas e eventos específicos. Tudo em múltipla escolha para proporcionar mais opções.\n\n### Segurança\n\nComo os webhooks são enviados para URLs públicas pela internet, não é possível evitar que alguém mal intencionado tente enviar um evento falso, fingindo ser da Eduzz. É por isso que criamos essa tela, onde você pode gerar chaves para validar se o evento realmente originou-se da Eduzz.\n\n![imagem_listagem_chaves](./images/secret/list.png)\n\nQuando a Eduzz envia uma mensagem, ela gera uma assinatura com base no conteúdo da mensagem e envia essa assinatura pelo cabeçalho HTTP. Como somente você e a Eduzz conhecem essas chaves, você pode recalcular essa assinatura e garantir a autenticidade da mensagem.\n\n![Histórico de envios](./images/integrations_signature.png)\n\nO cabeçalho x-signature é gerado usando a seguinte função (disponível em todas as linguagens de programação):\n\n```hmac('sha256', chave_secreta, corpo_da_requisição)```\n\nSe o valor resultante dessa função for idêntico ao valor no cabeçalho x-signature, a mensagem recebida é legítima.\n\nVocê também pode cadastrar quantas chaves desejar. Isso permite que, caso deseje enviar webhooks para sistemas de terceiros, esses envios sejam autenticados com chaves específicas, aumentando ainda mais a segurança.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Feduzz-webhook-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feduzz%2Feduzz-webhook-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feduzz%2Feduzz-webhook-docs/lists"}