Developers

Webhook subscriptions

Markdown

Send a test webhook

Sends a test webhook with test: true for a subscribed topic.

POST/stores/{storeId}/v1/webhook-subscriptions/{id}/test
No scope required

Path parameters

idstring (uuid)required

Request body

event_typestring

Response

dataobjectrequired
queuedobject
event_idstring
event_typestring
testobject
executionobject
Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
400EVENT_NOT_SUBSCRIBEDNot subscribed to this topic.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close