Create Shop Webhook

POST

/api/v1/openapi/create_shop_webhook

Register a webhook subscription for real-time event notifications. The webhook is scoped to the authenticated shop or platform.

Authentication: HMAC signature OR OAuth2 Bearer Token
Scope: Depends on topic — see topic-to-scope mapping below

Topic	Required Scope
review/created	write_reviews
review/updated	write_reviews
review/deleted	write_reviews
customer_event/created	read_customer_events

Platform isolation: When using OAuth2 Bearer Token, the webhook is scoped to the platform (platform_id). When using HMAC, it is scoped to the shop only (platform_id = 0).

Request

Authorization

API Key

Add parameter in header

Public-Token

Example:

Public-Token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Example

{
    "topic": "review/created",
    "url": "https://api.example.com/webhook"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://rapi.trustoo.io/api/v1/openapi/create_shop_webhook' \
--header 'Sign: 31ff687ec862dbf14cb1a75407e1681b5bde64feb350f545c22f69c095ddbaba' \
--header 'Timestamp: 1779678340' \
--header 'Public-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "topic": "review/created",
    "url": "https://api.example.com/webhook"
}'

Responses

🟢200

application/json

Webhook created

Bodyapplication/json

Example

{
    "code": 0,
    "message": "success",
    "time": 1750417608,
    "request_id": "dbf9af0f0436ee4f86ebee64e3828555",
    "data": {
        "id": "19",
        "topic": "review/created",
        "url": "https://api.example.com/webhook",
        "created_at": "2025-06-20T11:06:48Z",
        "updated_at": "2025-06-20T11:06:48Z"
    }
}

Modified at 2026-06-24 04:25:21

Cancel Platform Authorization

Update Shop Webhook