Skip to content
Navigation

Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • webhook
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • url
    optional
    string

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

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

    The events it is sent.

  • description
    optional

    One of the following:

    • string
    • null
  • enabled
    optional
    boolean

Returns

200

Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.

JSON
  • 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
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