Webhooks
Manage webhook registrations for receiving real-time event notifications.
Base URL: /api/v1/partner/webHooks
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/partner/webHooks | Create PARTNER WebHooks |
| PUT | /{webHookId} | Update PARTNER WebHooks |
| GET | /{webHookId} | Get PARTNER WebHooks By Id |
| GET | / | Get PARTNER WebHooks list |
| DELETE | /{id} | Delete partner webhook by id |
Create PARTNER WebHooks
POST /api/v1/partner/webHooks/api/v1/partner/webHooks
Create a new webhook registration. Configure the webhook URL and the event types you want to receive notifications for.
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
url | string | No | Url |
shopId | string | No | Shop identifier |
webHookUrls | string[] | Yes | Web Hook Urls |
{
"url": "string",
"shopId": "abc123",
"webHookUrls": []
}
Response
Returns a PartnerWebHook object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
url | string | No | Url |
webHookType | string | No | Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT |
webHookUrls | string[] | No | Web Hook Urls |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"url": "string",
"webHookType": "NEW_CONSUMER_ORDER",
"webHookUrls": []
}
Update PARTNER WebHooks
PUT /api/v1/partner/webHooks/{webHookId}
Update an existing webhook configuration by its ID. Send the full PartnerWebHook object in the request body.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
webHookId | string | The web hook i d |
Request Body
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
url | string | No | Url |
webHookType | string | No | Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT |
webHookUrls | string[] | No | Web Hook Urls |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"url": "string",
"webHookType": "NEW_CONSUMER_ORDER",
"webHookUrls": []
}
Response
Returns a PartnerWebHook object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
url | string | No | Url |
webHookType | string | No | Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT |
webHookUrls | string[] | No | Web Hook Urls |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"url": "string",
"webHookType": "NEW_CONSUMER_ORDER",
"webHookUrls": []
}
Get PARTNER WebHooks By Id
GET /api/v1/partner/webHooks/{webHookId}
Retrieve a single webhook registration by its ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
webHookId | string | The web hook i d |
Response
Returns a PartnerWebHook object.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
url | string | No | Url |
webHookType | string | No | Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT |
webHookUrls | string[] | No | Web Hook Urls |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"url": "string",
"webHookType": "NEW_CONSUMER_ORDER",
"webHookUrls": []
}
Get PARTNER WebHooks list
GET /api/v1/partner/webHooks
Retrieve a paginated list of webhook registrations. Optionally filter by type (event type) and shopId.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
start | integer | No | Number of records to skip |
limit | integer | No | Maximum records to return |
shopId | string | No | shop i d |
Response
Returns a paginated SearchResult of PartnerWebHook objects.
- Fields
- JSON
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier |
companyId | string | No | Company identifier |
shopId | string | No | Shop identifier |
created | long | No | Created timestamp (epoch ms) |
modified | long | No | Last modified timestamp (epoch ms) |
deleted | boolean | No | Whether the record is deleted |
updated | boolean | No | Whether the record has been updated |
url | string | No | Url |
webHookType | string | No | Web Hook Type. One of: NEW_CONSUMER_ORDER, NEW_CONSUMER_SIGNUP, UPDATE_CONSUMER_ORDER, UPDATE_CONSUMER_USER, NEW_MEMBER, UPDATE_MEMBER, CREATE_TRANSACTION, UPDATE_TRANSACTION, CANCEL_TRANSACTION, COMPLETE_TRANSACTION, UPDATE_PRODUCT |
webHookUrls | string[] | No | Web Hook Urls |
{
"id": "abc123",
"companyId": "abc123",
"shopId": "abc123",
"created": 1704067200000,
"modified": 1704067200000,
"deleted": false,
"updated": false,
"url": "string",
"webHookType": "NEW_CONSUMER_ORDER",
"webHookUrls": []
}
Delete partner webhook by id
DELETE /api/v1/partner/webHooks/{id}
Delete a webhook registration by its ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The id |