Create Webhook

POST

/partner/v1/webhooks

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠400Validation failed

🟠401Unauthorized

🟠403Missing scope / feature

🟠429Rate limited

Request Example

Shell

JavaScript

Java

Swift

curl --location '/partner/v1/webhooks' \
--header 'X-Store-Id: {{partner_store_id}}' \
--header 'Accept-Language: en' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://pos.example.com/hooks/yamm",
    "description": "POS returns sync",
    "subscribed_events": [
        "return.created",
        "return.approved"
    ],
    "api_version": "2026-04"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "url": "string",
        "api_version": "string",
        "description": "string",
        "secret": "string",
        "previous_secret_expires_at": "string",
        "subscribed_events": [
            "string"
        ],
        "is_active": true,
        "disabled_reason": "string",
        "created_at": "string",
        "updated_at": "string"
    }
}

List Webhooks

Get Webhook