This webhook will be called when there have been added an image or signature for the pickup history. The request from the webhook would look like this:
{
"webhookId": "64d05979a6ea2d015600f8d5",
"name": "pickupOrderFile",
"sent": "2023-07-06T08:40:28.297ZZ",
"data": [
{
"orderId": "5ad066886a9deecd679e6ac5",
"orderNumber": "WUX-123-45678901",
"requisition": "this-is-requisition",
"historyId": "64cefc58e5012800e57eec69",
"type": "image",
"fileURL": "https://example-url.com/image",
"pickupTime": "2024-04-21T12:34:56.789Z"
}
]
}
The data contains
| Key | Description |
|---|---|
| orderId | The id of the order. |
| orderNumber | The order number the order have been given. |
| requisition | The requisition the order have been given. |
| historyId | The id of the history where the file have been added to |
| type | What kind of file, at the moment it's either "file" or "signature" |
| fileURL | The url to the file |
| pickupTime | The time when the pickup history was registered that this file have been added to |
If orderNumber or requisition is not set, it will not be in the payload.
historyId and pickupTime can be used to group multiple pickups for an order together. For example any pickup for on an order will each have their own historyId unique for that