Set Notification

Register webhook URLs that à la carte will call when events (orders, status changes, inventory updates) occur. Limit: 3 webhook URLs per merchant.

When to Use

▾

Use this endpoint when:

• Setting up real-time notifications for à la carte events
• Sharing event payloads across multiple receivers (max 3)
• Scoping notifications to specific stores via storeIds

How to Use

▾

Endpoint

POST/v3/service

Step 1: Set Up Webhook Receivers

▾

Build HTTP endpoints (max 3) that accept JSON POST callbacks.

Step 2: Send the Configuration

▾

POST with function: "set.notification.webhook" and the list of notificationUrls. Optionally scope to specific storeIds.

Step 3: Verify Acceptance

▾

The response echoes the saved configuration including the notificationUrls list.

---

Request Parameters

▾

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "set.notification.webhook"

requestOBJECT

Refer to explanation below

notificationUrlsARRAYrequired

Maximum webhook url is 3

Example: ["https://webhook.site/2688336e-7b61-4cd2-b2bb-40592a3e353a"]

storeIdsARRAY

Merchant can set multi storeIds

Example: ["5eabf31ee0e9cd7b01a3a35e"]

Response Parameters

▾

clientIdSTRING

Client ID

Example: "3416044707690227346"

createdAtDATETIME

Creation date time

Example: "2020-09-22T04:44:57.950398414Z"

merchantIdSTRING

Merchant ID

Example: "Describe"

notificationUrlsARRAY

Maximum webhook url is 3

Example: ["https://webhook.site/2688336e-7b61-4cd2-b2bb-40592a3e353a"]

storeIdsARRAY

When store ID's is null mean will apply to all store

Example: null

updatedAtDATETIME

Last update date time

Example: "2020-09-22T04:44:57.950398414Z"