Upload Catalogue Webhook

post

https://api.developers.deliveroo.com/webhooks-upload

This webhook notifies you of the status of a catalogue upload, identified by a unique upload_id.
It is triggered once per upload to provide essential details on the upload's overall progress.
You can distinguish the webhook events from others by the event attribute.

Body Params

event

string

enum

name of the event. used to differentiate between CatalogueWebhookResponse and other events.

Allowed:

created_at

date-time

The time when the upload was created.

brand_id

string

The external brand ID.

catalogue_id

string

The ID of the catalogue.

status

string

enum

Allowed:

upload_id

string

The ID of the upload.

updated_at

date-time

The time when the upload was last updated.

error_messages

array of strings or null

If processing failed, details about the failures.

error_messages

warnings

array of objects

information about warnings that occurred when process the request. These warnings do not affect the success of the processing

warnings

Headers

x-deliveroo-sequence-guid

string

required

Deliveroo Sequential globally unique identifier (GUID). Please implement it as case-insensitive.

x-deliveroo-hmac-sha256

string

required

On registration, we'll provide you with a webhook secret. We'll use the webhook secret and a sequential globally unique identifier (GUID) to generate a hash of the order payload. When you receive a POST request, you will be able to compute a hash and verify that it's a genuine, authorized request sent from Deliveroo. Please implement it as case-insensitive.

Responses

200

Your server returns this code if it accepts the callback.

4XX

Your server can return 4XX codes to signal its issues with the request.

5XX

Your server can return 5XX codes to signal its internal issues.

Language

Credentials

OAuth2

URL