Skip to content

Adiciona detalhamento sobre webhooks#13

Open
tobiasfreire-gaudium wants to merge 6 commits into
mainfrom
topic/docs-sobre-webhooks
Open

Adiciona detalhamento sobre webhooks#13
tobiasfreire-gaudium wants to merge 6 commits into
mainfrom
topic/docs-sobre-webhooks

Conversation

@tobiasfreire-gaudium

Copy link
Copy Markdown
Contributor

Descrição

Adiciona detalhamento sobre o funcionamento, payloads e campos dos Webhooks da plataforma Machine. Para isso, é criada uma página em cada grupo Webhooks da documentação (tab Corridas V1, tab Entregas V1, V2).

@tobiasfreire-gaudium tobiasfreire-gaudium self-assigned this Jun 22, 2026
@gaudinho

gaudinho Bot commented Jun 22, 2026

Copy link
Copy Markdown

✅ Review postada — #13 (review)

job_id: mintlify-docs-13-1782159635463-b880

@gaudinho gaudinho Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bloqueador de correctness na documentação: o exemplo do payload do Webhook de Status tem as URLs de links.enterprise e links.driver trocadas em todos os 3 arquivos (enterprise aponta para /integracao/condutor e driver aponta para /integracao/empresa). Como é doc de API consumida por integradores externos, o exemplo copy/paste induz implementação errada. Demais pontos são sugestões informativas.

Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v1/referencia/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v2/referencia/webhooks/sobre.mdx
@tobiasfreire-gaudium

Copy link
Copy Markdown
Contributor Author

/gaudinho review

@gaudinho

gaudinho Bot commented Jun 22, 2026

Copy link
Copy Markdown

✅ Review postada — #13 (review)

job_id: mintlify-docs-13-1782160743211-fd88

gaudinho[bot]
gaudinho Bot previously approved these changes Jun 22, 2026

@gaudinho gaudinho Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentação clara e bem estruturada de webhooks (Posição, Status, Mensagens, formatos legados + assinatura HMAC). Cobre payload, campos, enums e exemplos nos 3 contextos (V1 corridas, V1 entregas, V2). Sugestões abaixo são informativas — não bloqueantes.

Comment thread pages/v2/referencia/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread docs.json
@jfelipends jfelipends requested a review from JRaphaelO June 23, 2026 17:00
@marcos-marques-gaudium

Copy link
Copy Markdown
Contributor

/gaudinho review

@gaudinho

gaudinho Bot commented Jun 25, 2026

Copy link
Copy Markdown

✅ Review postada — #13 (review)

job_id: mintlify-docs-13-1782410432139-e636

gaudinho[bot]
gaudinho Bot previously approved these changes Jun 25, 2026

@gaudinho gaudinho Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentação clara e bem estruturada sobre os novos webhooks (Posição, Status, Mensagens) com exemplos de payload, enums e campos. Diff é puramente docs (MDX + navegação no docs.json), sem risco de correctness/security. Apontei inconsistências entre payload de exemplo e tabela enum que valem ajustar antes do merge, mas não bloqueiam.

Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Comment thread pages/v1/entregas/webhooks/sobre.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants