Logo
Logo
⌘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
OrderStatusChange
Filters when topic is OrderStatusChange.
Show object attributes

statuses

array of enums

Required

Order status changes to subscribe to.
Possible enum values
PendingFulfillmentAction
The order requires user action before it can be sent to production.
Received
The order is received and is waiting to be sent to production. This period is to allow for cancellations to take place before production begins.
InProduction
The production facility is currently processing the order.
Shipped
The order has been shipped.
Delivered
The order has been delivered.
Canceled
The order was canceled.
ImagesProcessing
The order's design images are still being processed.
Show more values
ProductSetUpdated
Filters 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.
UploadStatusChange
Filters when topic is UploadStatusChange.
Show object attributes

statuses

array of enums

Required

Upload status changes to subscribe to.
Possible enum values
Success
The image was successfully uploaded.
Deleted
The image has been deleted.

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
OrderStatusChange
Triggered when the status of an order changes.
UploadStatusChange
Triggered when an upload fails or succeeds to upload.
ProductSetUpdated
Triggerred 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 -X POST 'https://www.artelo.com/api/open/webhooks/save' \
  -H 'Authorization: Bearer your-token' \
  -d '{
    "filters": {
      "statuses": [
        "Shipped"
      ]
    },
    "topic": "OrderStatusChange",
    "url": "https://api.example.com/artelo-webhook"
  }'
Response
{
  "filters": null,
  "id": "e747b74f-ae93-4594-a434-7fa3d7789ce8",
  "numFailures": 0,
  "secret": "test-secret",
  "topic": "OrderStatusChange",
  "url": "https://api.example.com/artelo-webhook"
}