Skip to content
Navigation

Allows a browser to receive the customer's notifications by push, as long as the session or token that adds it lasts.

POST
https://api.sherpo.io/customer/v1/stores/{store}/push_subscriptions

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    A hostname of the store.

Request body JSON required

  • endpoint
    string
    required

    The push service URL the browser's subscription names.

    maxLength: 1024 · minLength: 1
  • keys
    object
    required

    The subscription's keys, as the browser hands them over.

    • p256dh
      string
      required

      The browser's P-256 public key, base64url.

      maxLength: 128 · minLength: 1
    • auth
      string
      required

      The browser's authentication secret, base64url.

      maxLength: 64 · minLength: 1
  • revision
    optional

    The revision the caller's last write of this browser answered, or null for none; refused once another write changed it. Left out, nothing is checked.

    One of the following:

    • string
    • null

Returns

201

Allows a browser to receive the customer's notifications by push, as long as the session or token that adds it lasts.

JSON
  • endpoint
    string
    required
  • created_at
    string
    required
  • revision
    string
    required
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close