Webhook management

This public API includes webhook for the following cases: 1.Incoming orders(type="ORDER"), is the webhook where our service will send new orders.

2.Get Menu(type="Menu"), is the webhook where our service will get POS menu.

The URLs that will receive the requests must be configured with the following endpoint.

When you set a Menu type webhook, our service will send to you the store_id as a body parameter.

post
Set up webhook

https://integrations.mipos.shop/api/v1/integration/webhook/create
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Content-Type
required
string
application/json
Body Parameters
type
optional
string
Webhook type, by default is "ORDER"
url
required
string
Webhook URL
Response
201: Created
{
"message": "Webhook successfully created",
"data": null
}
401: Unauthorized
"Unauthorized."
409: Conflict
{
"message": [
"User not authenticated.",
"User not found.",
"This webhook already exists",
"Unable to set up the webhook URL."
],
"data": null
}
422: Unprocessable Entity
{
"url": [
"The url field is required."
]
}

post
Update webhook

https://integrations.mipos.shop/api/v1/integration/webhook/update
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Content-Type
required
string
application/jsonc
Body Parameters
current_url
required
string
Current webhook URL
new_url
required
string
New webhook URL
Response
200: OK
{
"message": "Webhook successfully updated",
"data": null
}
401: Unauthorized
"Unauthorized."
409: Conflict
{
"message": [
"User not authenticated.",
"User not found.",
"This webhook does not exist",
"This new webhook already exists",
"Unable to update the webhook URL."
],
"data": null
}
422: Unprocessable Entity
{
"current_url": [
"The current url field is required."
],
"new_url": [
"The new url field is required."
]
}

post
Delete webhook

https://integrations.mipos.shop/api/v1/integration/webhook/delete
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Content-Type
required
string
application/json
Body Parameters
url
required
string
Webhook URL
Response
200: OK
{
"message": "Webhook successfully removed",
"data": null
}
401: Unauthorized
"Unauthorized."
409: Conflict
{
"message": [
"User not authenticated.",
"User not found.",
"This webhook does not exist",
"Unable to remove the webhook URL."
],
"data": null
}
422: Unprocessable Entity
{
"url": [
"The url field is required."
]
}

get
Get user webhooks

https://integrations.mipos.shop/api/v1/integration/webhooks
Request
Response
Request
Headers
Authorization
required
string
Bearer {token}
Response
200: OK
[
{
"url": "https://urlwebhook1.test"
},
{
"url": "https://urlwebhook2.test"
},
{
"url": "https://urlwebhook3.test"
}
]
401: Unauthorized
"Unauthorized."
409: Conflict
{
"message": [
"User not authenticated.",
"User not found."
],
"data": null
}