Event Types

Overview of supported event types and how to retrieve them.

Supported Event Types

Event TypeDescriptionTrigger Condition
order.createdNew order initiatedCustomer starts checkout process
order.successPayment successfulPayment confirmed and completed
order.failedPayment failedPayment declined, failed, or cancelled
order.updatedOrder details updatedOrder information or status changes

Retrieve Event Types

To fetch available event types, use the following code:

async function getEventTypes() {
  const response = await fetch('https://backend.sa.amwal.tech/api/event-types/', {
    headers: {
      'X-API-Key': 'YOUR_API_KEY_FINGERPRINT'
    }
  });

  const events = await response.json();
  console.log('Available events:', events);
  return events;
}

Sample Response:

[
  {"id": 1, "name": "order.created"},
  {"id": 2, "name": "order.success"},
  {"id": 3, "name": "order.failed"},
  {"id": 4, "name": "order.updated"}
]