Update a subscribed Webhook

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/:id/webhooks.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Update the address to receive a specific Webhook notification.

CAUTION: For Webhook events v20240601 and later, use this API for updates. For managing Webhook events in earlier versions, follow these steps:

Public and custom apps: Go to Apps > Webhook configuration in the SHOPLINE Partner Portal.
Private apps: Go to Apps > Develop Apps > Edit > Permission configuration in the SHOPLINE Admin.

Path Parameters

id integer required
The unique identifier of the Webhook subscription record. You can obtain the value of this parameter from the response data in the following two APIs:
- Create a Webhook
- Get a list of Webhooks
Example: 13814

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

webhookobject required

Configuration information for the Webhook event subscription.
address string required

The callback URL to which the event notification is sent when the corresponding event occurs.
Maximum length: 255
Example: https://www.shopline.com/webhook

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

webhookobject

The Webhook event subscription information.
updated_at string

The date and time when the Webhook subscription record was last updated. Format: ISO 8601.
Example: 2024-01-31T18:21:06+08:00
address string

The callback URL to which the event notification is sent when the corresponding event occurs. Maximum length: 255
Example: https://www.shopline.com/webhook
api_version string

The version of this Webhook subscription API. Only v20240601 and later versions are supported.
Example: v20250301
created_at string

The date and time when the Webhook event was successfully subscribed for the first time. Format: ISO 8601.
Example: 2024-01-31T18:21:06+08:00
id integer

A unique identifier for the Webhook subscription record.
topic string

The specific event successfully subscribed to, such as products/create, which represents the product creation event.
Example: products/create

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

id — path required

Authorization — header required

Body

Body required

{
  "webhook": {
    "address": "https://www.shopline.com/webhook"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/id/webhooks.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal