DOCS

Webhooks

/

Escuchar eventos con webhooks

Reciba notificaciones de eventos en tiempo real para su integración con Zonos.

Los webhooks proporcionan una forma para que Zonos notifique proactivamente a sus sistemas externos cada vez que ocurren ciertos eventos. Cuando se produce el evento suscrito, Zonos enviará una solicitud HTTP POST a la URL del webhook que especifique. El cuerpo de la solicitud contendrá los detalles del evento, lo que permitirá a su sistema manejar el evento de manera programática.

Los webhooks son útiles para integrar Zonos con otras plataformas, activar flujos de trabajo automatizados y mantener los datos sincronizados entre sistemas en tiempo real. Por ejemplo, podría usar webhooks para:

  • Actualizar su sistema de gestión de pedidos cuando se crea un pedido en Zonos
  • Notificar a su proveedor de cumplimiento cuando se cancela un envío
  • Registrar cambios de estado de pedidos internacionales para fines de auditoría

Tipos de webhook 

Todos los tipos de webhook disponibles están incluidos en el WebhookType enum. Ejemplos de cargas útiles para cada uno se pueden encontrar en nuestra guía de Tipos de Eventos.

Creando webhooks 

Para crear un webhook a través de la API:

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation {
  webhookCreate(
    input: {
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Edita los detalles del webhook 

Para editar un webhook existente a través de la API:

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
mutation {
  webhookUpdate(
    input: {
      id: "webhook-id"
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Ver registros de webhook 

Para ver los registros de webhook a través de la API:

GraphQL

1
2
3
4
5
6
7
8
9
10
11
12
13
query {
  webhookLogs(first: 20, after: "yyyyyyy", filter: { type: ORDER_CREATED }) {
    edges {
      node {
        id
        type
        url
        createdAt
        responseStatus
      }
    }
  }
}

¿Fue útil esta página?