Magna API Documentation
  • Introduction
  • Authentication
  • Allocations
    • Allocation List
    • Allocation by ID
    • Claim Allocation Tokens
    • Schedule
  • Transactions
    • Transaction Signing Parameters
    • Indexing Transaction
  • Tokens
    • Tokens List
    • Token Summary
  • Nodes
  • Use Cases
  • Security Considerations
  • Webhooks
    • Getting Started
    • Register Webhooks
    • Security
    • Payload Schemas
    • FAQs
  • Claim Portal API
    • Allocations
    • Parameters
  • Protocol Hooks
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

Payload Schemas

Order Creation Payload Schema

When an order is created, Magna sends a webhook with the following payload structure:

{
  "id": "string (UUID)",
  "key": "string",
  "externalId": "string | null",
  "userId": "string (UUID) | null",
  "projectId": "string (UUID) | null",
  "walletAddress": "string | null",
  "email": "string | null",
  "totalAmount": "decimal",
  "status": "OrderStatus",
  "createdAt": "date",
  "updatedAt": "date",
  "orderItems": [
    {
      "id": "string (UUID)",
      "orderId": "string (UUID)",
      "type": "OrderItemType",
      "amount": "decimal",
      "quantity": "number (integer)",
      "createdAt": "date",
      "updatedAt": "date",
      "nodeKey": {
        "id": "string (UUID)",
        "tierId": "string (UUID)",
        "referralCodeId": "string (UUID) | null",
        "whitelistAddressId": "string (UUID) | null",
        "orderItemId": "string (UUID)"
      }
    }
  ]
}

PreviousSecurityNextFAQs

Last updated 7 months ago

Was this helpful?