POST AUShopify/{Sid}/webhook/{channel}/Subscribe

Request Information

URI Parameters

Name	Description	Type	Additional information
Sid		string	Required
channel		string	Required

Body Parameters

Subscription

Name	Type	Additional information
address	string	None.
api_version	string	None.
created_at	date	None.
fields	Collection of string	None.
format	string	None.
metafield_namespaces	Collection of string	None.
private_metafield_namespaces	Collection of string	None.
topic	string	None.
updated_at	date	None.
event	EventTopic	None.
id	integer	None.
admin_graphql_api_id	string	None.

Request Formats

application/json, text/json

Sample:

{
  "address": "sample string 1",
  "api_version": "sample string 2",
  "created_at": "2025-12-09T17:42:22.8749991+01:00",
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "format": "sample string 3",
  "metafield_namespaces": [
    "sample string 1",
    "sample string 2"
  ],
  "private_metafield_namespaces": [
    "sample string 1",
    "sample string 2"
  ],
  "topic": "sample string 4",
  "updated_at": "2025-12-09T17:42:22.8749991+01:00",
  "event": {
    "groupTopic": "Mixed",
    "shopifyTopic": "sample string 1",
    "friendlyName": "sample string 2",
    "description": "sample string 3",
    "Managed": true
  },
  "id": 1,
  "admin_graphql_api_id": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RSBaseOfSubscription

Name	Type	Additional information
Status	boolean	None.
ErrMessage	string	None.
ErrCode	ErrorCode	None.
Data	Subscription	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "ErrMessage": "sample string 2",
  "ErrCode": 0,
  "Data": {
    "address": "sample string 1",
    "api_version": "sample string 2",
    "created_at": "2025-12-09T17:42:22.9062502+01:00",
    "fields": [
      "sample string 1",
      "sample string 2"
    ],
    "format": "sample string 3",
    "metafield_namespaces": [
      "sample string 1",
      "sample string 2"
    ],
    "private_metafield_namespaces": [
      "sample string 1",
      "sample string 2"
    ],
    "topic": "sample string 4",
    "updated_at": "2025-12-09T17:42:22.9062502+01:00",
    "event": {
      "groupTopic": "Mixed",
      "shopifyTopic": "sample string 1",
      "friendlyName": "sample string 2",
      "description": "sample string 3",
      "Managed": true
    },
    "id": 1,
    "admin_graphql_api_id": "sample string 5"
  }
}