Shopping

Create Webhook

Create a pending order event subscription to a public HTTPS receiver. Returns its signing secret ONCE. The receiver must echo the signed verification challenge before activation. No customer contact fields are sent. Check expires_at and requires_active_grant. OAuth scopes: webhooks:write, orders:read. Changes buyer or order state. Requires a JSON object body; use {} for an operation without body fields.

post/webhooks

Request

  • Base URL: https://vesremont.com/api/v1
  • URL: https://vesremont.com/api/v1/webhooks
  • Auth: OAuth 2 (authorization code, authorization URL https://vesremont.com/oauth/authorize, token URL https://vesremont.com/oauth/token, scopes: webhooks:write, orders:read)

Request body

callback_urlstring uri required

Public HTTPS receiver under your control for signed verification and order events. Private-network, credential-bearing and unsafe receiver URLs are rejected; echo the signed challenge to activate.

eventsstring[] required

Distinct order event categories to subscribe to for this application and consenting buyer session. No customer contact fields are included.

Response

Successful operation.

idstring required
callback_urlstring uri required
eventsstring[] required
status'pending' | 'active' | 'deleted' | 'failed' | 'expired' required
requires_active_grantboolean required
created_atstring date-time required
updated_atstring date-time required
expires_atstring date-time required
signing_secretstring required

Changes

No recorded changes to this operation across all 1 revision of this API.