Configure Webhook

To integrate with the OrderOut API and receive real-time notifications for events, follow these steps to configure a webhook:

Create a Developer Account:

Register at the OrderOut Developer Portal.
Obtain your API key after completing the registration process.

Create an Endpoint:

Set up an endpoint in your API to receive webhook notifications. This endpoint should be capable of handling the payload sent by OrderOut.

Create a Webhook:

Use the OrderOut API to create a webhook for incoming orders. Send a POST request to https://api.orderout.co/api/webhooks/push_order

{  
    "endpoint": "https://example.com/your/endpoint/", 
    "method": "POST",  
    "authorization_header": {"Authorization": "Bearer somekey"}
}

Example payload of an order you will receive in your webhook:

{  
  "destination": {  
    "restaurantId": "b6c5ead5-c8db",  
    "restaurantName": "Acme's Restaurant"  
  },  
  "payload": {  
    "customer": {  
      "customerName": "John Doe",  
      "phoneNumber": "15552221234"  
    },  
    "order": {  
      "deliveryCharge": 1.99,  
      "driverComp": 0,  
      "gratuity": 0,  
      "items": \[`
        `{  
          "id": "item_id_1",  
          "modifiers": [  
            {  
              "id": "modifier_id_1",  
              "name": "Brioche Bun",  
              "price": 4.20,  
              "quantity": 1  
            }  
          ],  
          "name": "Meat Burger Sandwich",  
          "note": "Medium-Rare please",  
          "price": 11.90,  
          "quantity": 1,  
          "total": 11.90  
        }  
      ],`
      `"orderNotes": "",  
      "orderType": "PICKUP",  
      "payment": {  
        "status": "PAID"  
      },  
      "ready_by": "2024-05-29T12:50:36-0700",  
      "subtotal": 18.09,  
      "surcharge": 0,  
      "tax": 0.59,  
      "total": 18.68  
    }  
  },  
  "source": {`
    `"additionalInfo": "",  
    "deliveryCompany": {  
      "name": "your-channel"  
    },  
    "orderNumber": "3954956c677d",  
    "placedOn": "2024-05-29T12:47:59-0700"  
  }  
}

Log in to your OrderOut dashboard at OrderOut Dashboard.
Create an account and set up a restaurant profile.
Connect your Point of Sale (POS) system to the restaurant by submitting your POS ID.

Test the webhook:

Use the "Test Orders" feature in the dashboard to ensure your webhook is correctly receiving notifications.
Check the request, payload, and status in your developer portal to confirm that the webhook is functioning as expected.