awam for developers

Send the event. awam handles the update.

Connect any website, system or app through one small event endpoint. You do not need to recreate your system inside awam.

POST /api/v1/events/{connection-token}Quick start ↓
1

Create an API connection

From Business Settings → Connect your system. awam creates a private URL for that workspace.

2

Send one real event

awam detects the customer, phone, reference and event names from the first sample.

3

Map it to a human step

For example, order.shipped becomes Out for delivery. Every matching event then runs automatically.

QUICK START

One small request

Send the event name, object and customer. Use one stable event_id per update; retries are safe and do not duplicate the operation or message.

  • event what happened
  • object.id order or booking reference
  • object.customer name and WhatsApp number
curl -X POST "https://YOUR_AWAM_DOMAIN/api/v1/events/YOUR_CONNECTION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "order-100-shipped",
    "event": "order.shipped",
    "object": {
      "id": "ORDER-100",
      "type": "order",
      "customer": {
        "name": "Mariam",
        "phone": "+201001112222",
        "language": "ar"
      },
      "details": "Two grocery bags"
    }
  }'

Simple above. Safe underneath.

Every connection is workspace-isolated and rate-limited. Unknown events are held safely until you map them to the right stage.

Core responses

202Accepted or waiting for mapping200Duplicate already handled400Invalid required data429Temporary rate limit