Create a new Webhook

POST https://{handle}.myshopline.com/admin/openapi/v20250601/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 store, event, and version to create a Webhook subscription for a single store.

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 Object
address string required
[]
The address used by the plugin to receive event notifications.
[]
Example: https://www.shopline.com/webhook
api_version string required
[]
Version number, refer to the API Management Specifications for version control guidelines.
[]
Example: v20240601
topic string required
[]
Unique identifier of the event
[]
Example: products/create

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: v20240601
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
[]
Unique identifier of the event
[]
Example: products/create
updated_at string
[]
The date of the most recent successful modification to the event.
[]
Example: 2024-01-31T18:21:06+08:00

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "webhook": {
    "address": "https://www.shopline.com/webhook",
    "api_version": "v20240601",
    "topic": "products/create"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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",
    "api_version": "v20240601",
    "topic": "products/create"
  }
}
'

Was this article helpful to you?

SHOPLINE

Legal