Home
Home
API Reference
Tutorials
Changelog
Deprecations
No results found.
Introduction
Introduction to the Vend API
Intro
Authorization
Intro
Pagination
Intro
Rate limiting
Intro
Request formatting
Intro
User Agent
Intro
Date/time format
Intro
Data security
Intro
API 0.9
Consignments
Consignment Products
Customers
Outlets
Payment Types
Products
Registers
Register Sales
Suppliers
Taxes
Users
Webhooks
List webhooks
get
Create a webhook
post
Get a single webhook by ID
get
Update a webhook by ID
put
Delete a webhook by ID
delete
API 2.0
API 2.0 (BETA)
API 3.0 (BETA)
Powered by Stoplight
post

/webhooks

Creates and returns a new webhook. NOTE: The Content-Type header for this request should be set to application/x-www-form-urlencoded.

Authorization

apiKey - Authorization

Request Body

Form data (application/x-www-form-urlencoded)
data
string

The value of this field should be set as a string representing a JSON payload like: {"url":"http://123456.ngrok.io","active":true,"type":"product.update"}

required

Responses

200
1 Example
Schema
object

Webhook object

id
string

Auto-generated object ID.

1 validation + required
retailer_id
string

The ID of the retailer which the webhook request originated from.

1 validation + required
active
boolean

Indicates whether the webhook is active.

required
type
string

Webhook type. One of: product.update, inventory.update, sale.update, customer.update, consignment.receive, register_closure.create.

required
url
string

The URL of the endpoint prepared for receiving webhooks.

required

Send a Test Request

SettingsHeaders [2]BodyCode Generation
Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
domain_prefix
$$.env
1 variable not set
Authorization