Skip to content
Navigation

Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/webhooks

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

Request body JSON required

  • url
    string
    required

    An https URL on a public host; redirects are never followed.

    maxLength: 2048 · minLength: 1
  • events
    array of
    products.unlocked
    or
    request.received
    or
    request.waitlisted
    or
    request.approved
    or
    request.declined
    or
    request.expired
    +32 more
    required

    The events it is sent.

  • description
    optional

    One of the following:

    • string
    • null
  • enabled
    optional
    boolean

Returns

201

Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.

JSON
  • webhook
    object
    required
    • id
      string
      required
    • url
      string
      required
    • description
      required

      One of the following:

      • string
      • null
    • events
      array of
      string
      required
    • enabled
      boolean
      required
    • connection_ended_at
      required

      When it was turned off because the connection that set it up ended.

      One of the following:

      • string
      • null
    • created_at
      string
      required
    • updated_at
      string
      required
  • secret
    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