Subscribe to a new event
POST/api/v1/webhookWhen setting up a new webhook subscription, our system will verify the provided URL, along with the optional username and password. If the verification fails, the subscription will be rejected. For the verification to succeed, your endpoint must respond with a status code of 200.
Request
Body Params application/json
event
enum<string>
required
The event that will trigger the webhook.
Allowed value:
shipping
Example:
shipping
storeId
number
required
The ID of the store.
Example:
1088
url
string
required
The URL to send the webhook to.
Example:
https://www.example.com/webhook
username
string | null
optional
If the url is using a basic auth, the username of the basic auth.
Example:
Lumaprints
password
string | null
optional
If the url is using a basic auth, the password of the basic auth.
Example:
Password123
Example
{
"event": "shipping",
"storeId": "1088",
"url": "https://www.example.com/webhook",
"username": "Lumaprints",
"password": "Password123"
}Request samples
Responses
Created(201)
Duplicate Webhook URL(400)
URL Not accessible(400)
HTTP Code: 201
Content Type : JSONapplication/json
Data Schema
status
integer
required
message
string
required
Example
Success
{
"status": 201,
"message": "Webhook has been successfully created."
}Last modified: 4 months ago