Webhooks Overview

{
  "id": "evt_pay_1001",
  "event": "transaction",
  "api_version": "v1",
  "data": {
    "id": "018f1f2e-7b42-7c9a-8d3e-1a2b3c4d5e6f",
    "event_type": "transaction.paid",
    "correlation_id": "order_1001",
    "method": "pix",
    "status": "paid",
    "amount": 1500,
    "currency": "BRL",
    "informations": [
      { "key": "order_id", "value": "order_1001" }
    ],
    "customer": {
      "name": "Ana Souza",
      "email": "ana@example.com",
      "phone": "+5511999998888"
    },
    "products": [
      {
        "id": "018f1f2e-7b42-7c9a-8d3e-9f0a1b2c3d4e",
        "title": "Curso completo",
        "unit_price": 1500,
        "quantity": 1,
        "tangible": false,
        "kind": "product"
      }
    ],
    "attribution": {
      "utm_source": "instagram",
      "utm_medium": "cpc",
      "utm_campaign": "black-friday",
      "utm_content": null,
      "utm_term": null,
      "fbc": null,
      "fbp": null,
      "gclid": null,
      "ttclid": null,
      "src": null,
      "sck": null,
      "checkout_url": "https://pay.example/checkout/abc",
      "referrer_url": "https://instagram.com/"
    }
  }
}

{
  "id": "evt_payout_1001",
  "type": "payout.transferred",
  "api_version": "v2",
  "data": {
    "object": {
      "id": "018f1f2e-7b45-7c9a-8d3e-1a2b3c4d5e72",
      "status": "paid",
      "type": "pix",
      "amount": 1200
    }
  }
}

{
  "api_version": "v2",
  "id": "120ebf7cc24835b5ea33ee617bf70cb91c3a4dcd7413afcb05f61c60d1c9de3d",
  "event": "subscription",
  "url": "https://shop.example/webhooks/pagou",
  "data": {
    "id": "019e5d23-6ec8-73de-9c95-06093c62ba00",
    "event_type": "subscription.created",
    "status": "active",
    "amount": 500,
    "currency": "BRL",
    "latest_transaction": {
      "id": "019e5d23-6ed7-7121-a667-41e5ac929c72",
      "status": "paid"
    }
  }
}

{
  "received": true
}

{
  "error": "missing_event_id"
}