Subscribe

Subscribe allows the print partner to add webhook URL's that will allow Gelato to notify them.

POST /v2/subscribe

Request example

{
  "orderSubmitUrl": "https://order_submit_webhook.com",
  "orderCancelUrl": "https://order_cancel_webhook.com",
  "inventoryUrl": "https://inventory_webhook.com"
}

Success response example

{
  "message": "subscribed webhook"
}

Error response example

{
  "error": "invalid request"
}

Request

Parameter	Type	Description
orderSubmitUrl (required)	string	The URL for order submit webhook. Sample: https://order_submit_webhook.com.
orderCancelUrl (required)	string	The URL for order cancel webhook. Sample: https://order_cancel_webhook.com.
inventoryUrl (optional)	string	The URL for inventory webhook. Sample: https://inventory_webhook.com.

Success response

Parameter	Type	Description
message (required)	string	The message with the success. Sample: subscribed webhook.

Error response

Parameter	Type	Description
error (required)	string	The message with the error. Sample: invalid request.