Skip to content

Webhooks

Webhooks allow you to receive programmatic real-time notifications about changes to your data as they happen. Instead of pulling information through our API, webhooks will send information to your endpoint. To register a webhook, you need to follow the steps available at: https://developers.magalu.com/docs/Onboarding/setup/

Orders

Events generated during the order lifecycle will be sent to the previously registered webhook in the following format:

Response:

{
  "data": {
    "status": "new|approved|cancelled|finished",
    "params": {"id": "<order id>"},
    "resource": "<url_order>" 
  }
}

Deliveries

Events generated during the lifecycle of a delivery will be sent to the previously registered webhook in the following format:

Response:

{
  "data": {
    "status": "shipped|approved|cancelled|delivered",
    "params": {"id": "<delivery id>"},
    "resource": "<url_delivery>" 
  }
}