Webhook Setup

Webhook Event Setup

To ensure secure and successful delivery of webhook events to your systems, we require some essential information from you. We recommend working with your POS Portal Account Manager to identify the specific events you want to subscribe to and provide the necessary credentials for secure integration.

---

What You Need to Provide

1. Root URL and Path Mapping

• Supply a root URL where we can deliver webhook events (e.g., https://api.yourdomain.com/webhooks).
• Our system supports posting different events to specific paths off your root URL. For example:
  • Order events: /orders/shipped
  • Package tracking updates: /packages/deliveryConfirmed
  • Support tickets: /tickets/created

Ensure your listener is configured to accept requests at these paths.

2. Authorization Credentials

For more information on Webhook Authorization and Credentials, please reference Webhook Authorization page.

---

How We Post Events

• Events are sent as HTTP POST requests to the provided URL paths.
• Each request includes:
  • A JSON payload with the event details.
  • Authorization headers based on the method you configure (e.g., OAuth Bearer token).
  • A unique event ID for traceability.

---

Configuring Your Listener

To receive our webhook events:

1. Configure your listener to accept and validate POST requests at the specified paths.
2. Implement authentication to verify the credentials provided in the request (OAuth 2.0 strongly recommended).
3. Log and respond with a success status (200 OK) for each received event.

---

Testing & Verification

Before going live, we recommend:

• Testing your listener setup using sample events.
• Validating the authorization process to ensure smooth integration.