Subscribe - Bolder Developers

Creates a new webhook subscription. After creation the API sends a verification POST to your url containing a X-Hook-Ping header. Your endpoint must respond with a matching X-Hook-Pong header to activate the subscription.

Subscription states

Status	Description
`pending`	Created, awaiting verification
`active`	Verified and receiving events
`failed_activation`	Verification was rejected
`failed`	Disabled after 3 consecutive delivery failures
`disabled`	Manually disabled or target returned `410`

Available event topics

Orders: orders, orders.created, orders.created.checkout, orders.updated, orders.updated.placed, orders.updated.closed, orders.updated.shipped, orders.updated.cancelled, orders.deleted

Products: products, products.created, products.updated, products.deleted, products.updated.variants.created, products.updated.variants.updated, products.updated.variants.deleted, products.updated.assets.created, products.updated.assets.deleted

POST/hub/{shop_id}/subscriptions

Authorization

AuthorizationBearer token (JWT) · headerrequired

OAuth 2.0 Bearer token. Obtain via POST https://auth.onbolder.com/oauth/token.

Path parameters

shop_idintegerrequired

Request body

requiredapplication/json

topicstringrequired

Event topic to subscribe to, e.g. orders.updated.placed

urlstringrequired

URL to POST event notifications to

notify_originboolean

Whether to notify the originating app

default: true

authSubscriptionAuth

Show properties

typestring

Allowed:nonebasic

usernamestring

passwordstring

Responses

201

Subscription created (pending verification)

idinteger

statusstring

Allowed:pendingactivefailed_activationfaileddisabled

topicstring

urlstring

notify_originboolean

authSubscriptionAuth

Show properties

typestring

Allowed:nonebasic

usernamestring

passwordstring

error_countinteger

last_errorstring | null

created_onstring<date-time>

updated_onstring<date-time>

_linksobject

422

Validation errors

_classstring[]

_embeddedobject

Show properties

errorsobject[]

Show properties

Array of object

_classstring[]

fieldstring

messagesstring[]

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.onbolder.com/v1/hub/0/subscriptions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "topic": "orders.updated.placed",
  "url": "https://www.myapp.com/events",
  "notify_origin": true,
  "auth": {
    "type": "basic",
    "username": "foo",
    "password": "bar"
  }
}'

const response = await fetch("https://api.onbolder.com/v1/hub/0/subscriptions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"topic\": \"orders.updated.placed\",\n  \"url\": \"https://www.myapp.com/events\",\n  \"notify_origin\": true,\n  \"auth\": {\n    \"type\": \"basic\",\n    \"username\": \"foo\",\n    \"password\": \"bar\"\n  }\n}"
});

import requests

response = requests.post(
    "https://api.onbolder.com/v1/hub/0/subscriptions",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"topic\": \"orders.updated.placed\",\n  \"url\": \"https://www.myapp.com/events\",\n  \"notify_origin\": true,\n  \"auth\": {\n    \"type\": \"basic\",\n    \"username\": \"foo\",\n    \"password\": \"bar\"\n  }\n}",
)

Response

{
  "id": 0,
  "status": "pending",
  "topic": "string",
  "url": "string",
  "notify_origin": true,
  "auth": {
    "type": "none",
    "username": "string",
    "password": "string"
  },
  "error_count": 0,
  "last_error": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "_links": {}
}

{
  "_class": [
    "errors"
  ],
  "_embedded": {
    "errors": [
      {
        "_class": [
          "error"
        ],
        "field": "product.title",
        "messages": [
          "can't be blank"
        ]
      }
    ]
  }
}