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.

Set up webhook

POST https://integrations.mipos.shop/api/v1/integration/webhook/create

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-Type	string	application/json

Request Body

Name	Type	Description
type	string	Webhook type, by default is "ORDER"
url	string	Webhook URL

201

{
    "message": "Webhook successfully created",
    "data": null
}

401

"Unauthorized."

409

{
    "message": [
        "User not authenticated.",
        "User not found.",
        "This webhook already exists",
        "Unable to set up the webhook URL."
    ],
    "data": null
}

422

{
    "url": [
        "The url field is required."
    ]
}

Update webhook

POST https://integrations.mipos.shop/api/v1/integration/webhook/update

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-Type	string	application/jsonc

Request Body

Name	Type	Description
current_url	string	Current webhook URL
new_url	string	New webhook URL

200

{
    "message": "Webhook successfully updated",
    "data": null
}

401

"Unauthorized."

409

{
    "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

{
    "current_url": [
        "The current url field is required."
    ],
    "new_url": [
        "The new url field is required."
    ]
}

Delete webhook

POST https://integrations.mipos.shop/api/v1/integration/webhook/delete

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-Type	string	application/json

Request Body

Name	Type	Description
url	string	Webhook URL

200

{
    "message": "Webhook successfully removed",
    "data": null
}

401

"Unauthorized."

409

{
    "message": [
        "User not authenticated.",
        "User not found.",
        "This webhook does not exist",
        "Unable to remove the webhook URL."
    ],
    "data": null
}

422

{
    "url": [
        "The url field is required."
    ]
}

Get user webhooks

GET https://integrations.mipos.shop/api/v1/integration/webhooks

Headers

Name	Type	Description
Authorization	string	Bearer {token}

200

[
    {
        "url": "https://urlwebhook1.test"
    },
    {
        "url": "https://urlwebhook2.test"
    },
    {
        "url": "https://urlwebhook3.test"
    }
]

401

"Unauthorized."

409

{
    "message": [
        "User not authenticated.",
        "User not found."
    ],
    "data": null
}