DOCS

Webhooks

Ouça eventos com webhooks

Receba notificações de eventos em tempo real para sua integração Zonos.

Webhooks fornecem uma maneira para Zonos notificar proativamente seus sistemas externos sempre que determinados eventos ocorrerem. Quando o evento inscrito ocorrer, Zonos enviará uma solicitação HTTP POST para o URL do webhook que você especificar. O corpo da solicitação conterá os detalhes do evento, permitindo que seu sistema trate o evento de forma programática.

Webhooks são úteis para integração Zonos com outras plataformas, acionando fluxos de trabalho automatizados e mantendo os dados sincronizados entre sistemas em tempo real. Por exemplo, você pode usar webhooks para:

  • Atualize seu sistema de gerenciamento de pedidos quando um pedido for criado em Zonos
  • Notifique seu provedor de atendimento quando uma remessa for cancelada
  • Registrar alterações de status de pedidos internacionais para fins de auditoria

Tipos de webhook 

Todos os tipos de webhook disponíveis estão incluídos no WebhookTypeenum. Exemplos de cargas úteis para cada um podem ser encontrados em nosso Tipos de eventosguia.

Criando webhooks 

Para criar um webhook através do API:

1mutation WebhookCreate($input: WebhookCreateInput!) {
2 webhookCreate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

Editar detalhes do webhook 

Para editar um webhook existente por meio do API:

1mutation WebhookUpdate($input: WebhookUpdateInput!) {
2 webhookUpdate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

Ver registros de webhook 

Para visualizar logs de webhook por meio do API:

1query WebhookLogs(
2$first: Int
3$after: String
4$filter: WebhookLogsFilterInput
5) {
6 webhookLogs(first: $first, after: $after, filter: $filter) {
7 edges {
8 node {
9 id
10 type
11 url
12 createdAt
13 responseStatus
14 }
15 }
16 }
17}
GraphQL API ReferenceTypes, inputs, and operations used in this guide

Esta página foi útil?