Ouça eventos com webhooks

Webhooks fornecem uma maneira para Zonos notificar proativamente seus sistemas externos sempre que certos eventos ocorrerem. Quando o evento assinado ocorre, Zonos enviará uma solicitação HTTP POST para a URL do webhook que você especificar. O corpo da solicitação conterá os detalhes do evento, permitindo que seu sistema lide com o evento programaticamente.

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

• Atualizar seu sistema de gerenciamento de pedidos quando um pedido é criado no Zonos
• Notificar seu provedor de atendimento quando um envio é cancelado
• 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 enum WebhookType. Exemplos de payloads para cada um podem ser encontrados em nosso guia Tipos de Eventos.

Criando webhooks 

Para criar um webhook via API:

mutation {
  webhookCreate(
    input: {
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Editar detalhes do webhook 

Para editar um webhook existente via API:

mutation {
  webhookUpdate(
    input: {
      id: "webhook-id"
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Visualizar logs de webhook 

Para visualizar logs de webhook via API:

query {
  webhookLogs(first: 20, after: "yyyyyyy", filter: { type: ORDER_CREATED }) {
    edges {
      node {
        id
        type
        url
        createdAt
        responseStatus
      }
    }
  }
}