Webhooks provide a powerful mechanism for integrating external systems with your CartAI account. By subscribing to specific events within CartAI, you can receive real-time notifications via HTTP requests to a configured endpoint. This enables you to automate workflows and maintain up-to-date information regarding the status of critical entities, particularly checkout tasks.

To subscribe to webhook you can use the webhook subscription module from the CartAI Admin portal.

Supported Authentication

CartAI supports various authentication methods including Basic Authentication & OAuth0. It also allows you to add support for additional headers.

Even though its not recommended for production application, but for having testing flexibility webhook can be configured without any authentication at all.

Lifecycle of the Checkout Task

Event	Description
QUEUED	A new checkout task has been submitted to the execution queue.
STARTED	Execution of the checkout task has been started by the executor.
IN-PROGRESS	Execution in Progress
PENDING_CONFIRMATION	Only be used in the lifecycle selected for the Confirmation-Required Purchases. For the other strategies it will be fast-forwarded or by-passed. Please refer to CheckoutTask.derivedDetails from below payload example
CONFIRMED	A checkout is confirmed by the Customer. Will mostly be used by the Confirmation-Required Purchases. For the other strategies it will be fast-forwarded or by-passed.
CANCELLED	A checkout task was cancelled by the customer or integrator.
PLACED	Order is placed
COMPLETED	A checkout task was successfully completed.
FAILED	A Checkout task failed.

Sample Payload

{
  "tid": "019af513-ea98-7d21-8f36-3dbe36dd4e05",
  "status": "IN_PROGRESS",
  "createdAt": "2025-12-06T19:11:54.519Z",
  "groupId": "019af513-ea97-7552-91e9-e1f113ea0361",
  "merchant": "saltiebeauty.com",
  "tasks": [
    {
      "url": "https://saltiebeauty.com/products/sea-salt-texturizing-spray-enriched-with-sea-salt-marine-botanicals-8-fl-oz-250-ml",
      "quantity": 1,
      "selectedVariant": {
        "color": "",
        "size": "",
        "fit": ""
      },
      "options": null,
      "metadata": {
        "title": "",
        "description": "",
        "primaryImage": "",
        "price": ""
      }
    }
  ],
  "derivedDetails": {
    "pricing": null,
    "shippingMethod": null,
    "selectedShippingOption": null
  },
  "customer": {
    "contact": {
      "firstName": "Carol",
      "lastName": "Sturka",
      "email": "carol.sturka@gmail.com",
      "phone": "+16507083507"
    },
    "shippingAddress": {
      "addressLine1": "6104 Plano Parkway",
      "addressLine2": "",
      "city": "Plano",
      "province": "Texas",
      "postalCode": "75093",
      "country": "United States"
    },
    "billingAddress": null,
    "shippingMethod": {
      "strategy": "cheapest"
    },
    "payment": {
      "provider": "nekuda",
      "data": {
        "userId": "WTJGeWIyd3VjM1IxY210aFFHVjRZVzF3YkdVdVkyOXQ="
      }
    }
  }
}