⌘K
Save Webhook
Create or update a webhook.
Parameters
filters
object
Filters to narrow conditions for when to send the webhook. The filter options are dependent on the
topic field.Possible values
OrderStatusChangeFilters when
topic is OrderStatusChange.Show object attributes
statuses
array of enums
Required
Order status changes to subscribe to.
Possible enum values
PendingFulfillmentActionThe order requires user action before it can be sent to production.
AwaitingPaymentThe order has been received by Artelo but is not yet paid for in the connected integration.
ReceivedThe order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
InProductionThe production facility is currently processing the order.
ShippedThe order has been shipped.
DeliveredThe order has been delivered.
CanceledThe order was canceled.
Show more values
ProductSetUpdatedFilters when
topic is ProductSetUpdated.Show object attributes
productSetIds
array of strings
Unique identifiers of product sets to subscribe to changes for. If not included, the webhook will subscribe to changes for all product sets.
UploadStatusChangeFilters when
topic is UploadStatusChange.Show object attributes
statuses
array of enums
Required
Upload status changes to subscribe to.
Possible enum values
SuccessThe image was successfully uploaded.
FailThe image failed to upload.
id
number
Unique identifier of the webhook to update. Only include when updating a webhook.
topic
enum
Required
Topic to subscribe the webhook to.
Possible enum values
OrderStatusChangeTriggered when the status of an order changes.
UploadStatusChangeTriggered when an upload fails or succeeds to upload.
ProductSetUpdatedTriggerred when a product set is updated.
url
string
Required
URL to send POST requests to for the webhook.
Returns
The newly created or updated
Webhook object.POST
/webhooks/save
cURL
Response