Modify an existing Webhook

PUT https://{handle}.myshopline.com/admin/openapi/v20250601/: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 .

[]

Specify the subscribed Webhook and modify the address for receiving Webhooks.

info

The current interface only supports Webhook events from version v20240601 and later.

For earlier versions, please manage through the partner portal.

Path Parameters

id integer required
[]
The unique ID of the subscription record, which can be obtained by querying the interface for subscription records.

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

webhookobject required
[]
Webhook Modification Object
address string required
[]
The address where the application receives event notifications, fill in the newly modified address.
[]
Example: https://www.shopline.com/webhook

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

webhookobject
[]
Webhook Subscription Object
address string
[]
The address where the application receives event notifications.
[]
Example: https://www.shopline.com/webhook
api_version string
[]
Version number, refer to the API Management Specifications for version control guidelines.
[]
Example: v20250301
created_at string
[]
The time the event was created
[]
Example: 2024-01-31T18:21:06+08:00
id integer
[]
The unique ID of the Webhook subscription record.
topic string
[]
The unique identifier of the currently successfully modified event.
[]
Example: products/create
updated_at string
[]
The time when the event was last modified successfully
[]
Example: 2024-01-31T18:21:06+08:00

API Explorer

Debugger

Base URL

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

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/v20250601/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' \
     --data '
{
  "webhook": {
    "address": "https://www.shopline.com/webhook"
  }
}
'

Was this article helpful to you?

SHOPLINE

Legal