Skip to content

feat: gzip webhook format on intro #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vinicius-eidy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: gzip webhook format on intro #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/webhooks/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,17 @@ Acesse nosso painel admin, em Instâncias clique no olho "visualizar" na instân
### Via api

Também é possível atualizar a rota do seu webhook chamando o endpoint de update. Esse endpoint é disponibilizado nos próximos tópicos da documentação.

---

## Formato Gzip

A compactação Gzip pode diminuir bastante o tamanho do corpo de resposta e assim aumentar a velocidade de um aplicativo da web.

Diante disso, em novembro de 2024 foi lançada uma atualização do Z-API em que os webhooks poderão ser recebidos no formato Gzip.

Para isso, você vai precisar descomprimir os dados do webhook que chegarão no formato Gzip. Mas não se preocupe, vamos te auxiliar abaixo.

### Como descompactar Gzip

Para auxiliá-los nesse processo, criamos um repositório com diversas aplicações que descompactam o Gzip utilizando diferentes linguagens e frameworks. Para saber mais, acesse o [link do repositório](https://github.com/Z-API/z-api-gzip-decompress).
19 changes: 19 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/current/webhooks/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,22 @@ Acesse nosso painel admin, vá em opções e escolha "editar instância".
Access our admin panel, go to options and choose "edit instance"

![img](../../../../../img/EditInstance.jpeg)


### API

You can also update your webhook's rotation by calling the update endpoint. This endpoint is available in the detailed documentation details.

---

## Gzip format

Gzip compression can greatly decrease the size of the response body and thus increase the speed of a web application.

Therefore, in November 2024 an update to the Z-API was released in which webhooks can be received in Gzip format.

To do this, you will need to decompress the webhook data that will arrive in Gzip format. But don't worry, we'll help you below.

### How unzip Gzip

To assist you in this process, we created a repository with several applications that decompress Gzip using different languages ​​and frameworks. To learn more, visit [repository link](https://github.com/Z-API/z-api-gzip-decompress).